Tile - YGameSession - Get Reserved Game Id – Ylands
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
==Overview== | |||
[[Image:{{PAGENAME}}.png]] | [[Image:{{PAGENAME}}.png]] | ||
*Instruction allowing to transfer a player to a game within same [[Ylands Game set|'''Game set''']]. | *Instruction allowing to transfer a player to a game within same [[Ylands Game set|'''Game set''']]. | ||
| Line 6: | Line 7: | ||
==Start Matchmaking== | |||
*Player will be added to [[Ylands Matchmaking|'''Matchmaker''']] queue for listed games. | *Player will be added to [[Ylands Matchmaking|'''Matchmaker''']] queue for listed games. | ||
**'''Guids''' - list ([[Ylands Tile category - Array|'''Array''']]) of [[Ylands Change Game ID|'''Game ID''']] obtained via [[Ylands Game set|'''Game set manager''']] which the player will be matched to. | **'''Guids''' - list ([[Ylands Tile category - Array|'''Array''']]) of [[Ylands Change Game ID|'''Game ID''']] obtained via [[Ylands Game set|'''Game set manager''']] which the player will be matched to. | ||
| Line 18: | Line 19: | ||
*If the reservation will fail, the instruction will return a '''Fail reason'''. | *If the reservation will fail, the instruction will return a '''Fail reason'''. | ||
==Cancel matchmaking== | |||
*This instruction will '''cancel''' current [[Ylands Matchmaking|'''Matchmaker''']] request. | *This instruction will '''cancel''' current [[Ylands Matchmaking|'''Matchmaker''']] request. | ||
==Dispatch session== | |||
*This instruction will '''dispatch''' selected player using the '''Session object'''. | *This instruction will '''dispatch''' selected player using the '''Session object'''. | ||
==Fail reason== | |||
*Reason why the reservation has failed. | *Reason why the reservation has failed. | ||
*Can be compared with [[Ylands Tile - Matchmaking fail type|'''corresponding enumerator''']]. | *Can be compared with [[Ylands Tile - Matchmaking fail type|'''corresponding enumerator''']]. | ||
==Get reserved Game Id== | |||
*Returns the [[Ylands Change Game ID|'''Game ID''']] of game where the player can be dispatched to. | *Returns the [[Ylands Change Game ID|'''Game ID''']] of game where the player can be dispatched to. | ||
*Guid is determined from the '''Session object'''. | *Guid is determined from the '''Session object'''. | ||
==Example== | |||
<gallery> | <gallery> | ||
Image: Ylands-Game-set-session-2.png|Example | Image: Ylands-Game-set-session-2.png|Example | ||
Revision as of 16:45, 7 September 2020
Overview
File:Tile - YGameSession - Get Reserved Game Id.png
- Instruction allowing to transfer a player to a game within same Game set.
- Player will be added to Matchmaker queue. If there will enough players queuing for the same game, they will be then transferred to newly spawned server of that game.
- The Matchmaker will always spawn new server instance if enough players are available.
- The Matchmaker will not transfer player to already running instances.
Start Matchmaking
- Player will be added to Matchmaker queue for listed games.
- Guids - list (Array) of Game ID obtained via Game set manager which the player will be matched to.
- Player - player to be added to Matchmaker queue.
- Priority - Matchmaker request priority.
- Player requests with higher priority are prioritized over the other.
- If there are players matchmaking for same game(s), but with lower priority, they will be added to the players with higher priority.
- If the reservation will be successful, the instruction will return a Session object.
- Session object - contains target server and player to be dispatched.
- If the reservation will fail, the instruction will return a Fail reason.
Cancel matchmaking
- This instruction will cancel current Matchmaker request.
Dispatch session
- This instruction will dispatch selected player using the Session object.
Fail reason
- Reason why the reservation has failed.
- Can be compared with corresponding enumerator.
Get reserved Game Id
- Returns the Game ID of game where the player can be dispatched to.
- Guid is determined from the Session object.
Example
Example
