@xmobitea/gn-server/apiReferences/Multiplayer.json

GearN Server by XmobiTea (Pro)

{"requestType":"Multiplayer","operations":[{"operationCode":"CancelAllMatchmakingTicket","details":[{"role":"Client","requestData":[{"code":"QueueName","description":"","optional":false,"type":"string","gnType":"String","conditions":{"minLength":6,"maxLength":32}}]},{"role":"Server","requestData":[{"code":"UserId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"minLength":10,"maxLength":10}}]}],"responseData":[{"code":"ErrorCode","value":["MatchmakingQueueNotFound","Ok"]},{"code":"TicketIds"}],"description":""},{"operationCode":"CancelMatchmakingTicket","details":[{"role":"Client","requestData":[{"code":"TicketId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"minLength":10,"maxLength":10}}]},{"role":"Server","requestData":[{"code":"UserId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"minLength":10,"maxLength":10}}]}],"responseData":[{"code":"ErrorCode","value":["MatchmakingTicketNotFound","MatchmakingTicketAlreadyCompleted","MatchmakingPlayerHasNotJoinedTicket","Ok"]}],"description":""},{"operationCode":"CreateMatchmakingTicket","details":[{"role":"Client","requestData":[{"code":"GiveUpAfterSeconds","description":"","optional":false,"type":"number","gnType":"Number","conditions":{"mustInt":true,"minValue":20}},{"code":"QueueName","description":"","optional":false,"type":"string","gnType":"String","conditions":{"minLength":6,"maxLength":32}},{"code":"Attribute","description":"","optional":true,"type":"GNHashtable","gnType":"GNHashtable","conditions":{}},{"code":"Members","description":"","optional":true,"type":"string","gnType":"GNArray","conditions":{}}]},{"role":"Server","requestData":[{"code":"UserId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"minLength":10,"maxLength":10}}]}],"responseData":[{"code":"ErrorCode","value":["MatchmakingQueueNotFound","MatchmakingPlayerHasJoinedOtherTicket","TicketSizeError","Ok"]},{"code":"TicketId"}],"description":""},{"operationCode":"GetAllMatchmakingTicket","details":[{"role":"Client","requestData":[{"code":"Status","description":"","optional":true,"type":"number","gnType":"Number","conditions":{"mustInt":true,"minValue":1,"maxValue":5}},{"code":"ReturnMember","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}},{"code":"Skip","description":"","optional":true,"type":"number","gnType":"Number","defaultValue":"0","conditions":{"mustInt":true,"minValue":0}},{"code":"Limit","description":"","optional":true,"type":"number","gnType":"Number","defaultValue":"10","conditions":{"mustInt":true,"minValue":1,"maxValue":100}}]}],"responseData":[{"code":"ErrorCode","value":["Ok"]},{"code":"Results"}],"description":""},{"operationCode":"GetAllMatch","details":[{"role":"Client","requestData":[{"code":"ReturnMember","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}},{"code":"Skip","description":"","optional":true,"type":"number","gnType":"Number","defaultValue":"0","conditions":{"mustInt":true,"minValue":0}},{"code":"Limit","description":"","optional":true,"type":"number","gnType":"Number","defaultValue":"10","conditions":{"mustInt":true,"minValue":1,"maxValue":100}}]}],"responseData":[{"code":"ErrorCode","value":["Ok"]},{"code":"Results"}],"description":""},{"operationCode":"GetMatchmakingTicket","details":[{"role":"Client","requestData":[{"code":"TicketId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"minLength":10,"maxLength":10}},{"code":"ReturnMember","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}}]}],"responseData":[{"code":"ErrorCode","value":["MatchmakingTicketNotFound","Ok"]},{"code":"MatchmakingTicket"}],"description":""},{"operationCode":"GetMatch","details":[{"role":"Client","requestData":[{"code":"MatchId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"minLength":15,"maxLength":15}},{"code":"ReturnMember","description":"","optional":true,"type":"boolean","gnType":"Boolean","defaultValue":"false","conditions":{}}]}],"responseData":[{"code":"ErrorCode","value":["MatchNotFound","Ok"]},{"code":"Match"}],"description":""},{"operationCode":"GetQueueStatistics","details":[{"role":"Client","requestData":[{"code":"QueueName","description":"","optional":false,"type":"string","gnType":"String","conditions":{"minLength":6,"maxLength":32}},{"code":"TimeInSeconds","description":"","optional":false,"type":"number","gnType":"Number","conditions":{"mustInt":true,"minValue":20}}]}],"responseData":[{"code":"PendingMemberCount"},{"code":"PendingTicketCount"},{"code":"AverageMatchmakingTimeInSeconds"}],"description":""},{"operationCode":"JoinMatchmakingTicket","details":[{"role":"Client","requestData":[{"code":"TicketId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"minLength":10,"maxLength":10}},{"code":"Attribute","description":"","optional":true,"type":"GNHashtable","gnType":"GNHashtable","conditions":{}}]},{"role":"Server","requestData":[{"code":"UserId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"minLength":10,"maxLength":10}}]}],"responseData":[{"code":"ErrorCode","value":["MatchmakingTicketNotFound","MatchmakingTicketAlreadyCompleted","MatchmakingQueueNotFound","MatchmakingPlayerHasJoinedOtherTicket","Ok"]}],"description":""},{"operationCode":"ListMatchmakingTicketsForPlayer","details":[{"role":"Client","requestData":[{"code":"QueueName","description":"","optional":false,"type":"string","gnType":"String","conditions":{"minLength":6,"maxLength":32}}]},{"role":"Server","requestData":[{"code":"UserId","description":"","optional":false,"type":"string","gnType":"String","conditions":{"minLength":10,"maxLength":10}}]}],"responseData":[{"code":"ErrorCode","value":["Ok"]},{"code":"TicketIds"}],"description":""}],"models":[]}