Tile - YGameSession - Reserve Session – Ylands
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 6: | Line 6: | ||
**Game instance = game running on official dedicated server. | **Game instance = game running on official dedicated server. | ||
**Target game instance is chosen automatically. | **Target game instance is chosen automatically. | ||
**If there wont be any instance | **If there wont be any instance available, new instance will be spawned automatically. | ||
*In order to reserve session, following input parameters has to be entered | *In order to reserve session, following input parameters has to be entered | ||
**'''Guid''' - [[Ylands Change Game ID|'''Game ID''']] obtained via [[Ylands Game set|'''Game set manager''']] | **'''Guid''' - [[Ylands Change Game ID|'''Game ID''']] obtained via [[Ylands Game set|'''Game set manager''']] | ||
Revision as of 14:26, 13 January 2020
File:Tile - YGameSession - Reserve Session.png
- Instructions allowing to transfer players between Game set games.
Reserve session
- If a free game instance is available, this instruction will try to reserve a game session for selected players.
- Game instance = game running on official dedicated server.
- Target game instance is chosen automatically.
- If there wont be any instance available, new instance will be spawned automatically.
- In order to reserve session, following input parameters has to be entered
- Guid - Game ID obtained via Game set manager
- Players - list of players (Array) to be transferred.
- If the reservation will be successful, the instruction will return a Session object.
- Session object - contains target server and list of players to be dispatched.
- If the reservation will fail, the instruction will return a Fail reason.
Dispatch session
- This instruction will dispatch selected players using the Session object.
Fail reason
- Reason why the reservation has failed.
- Can be compared with coresponding enumerator.
Example
Example
