Tile - YGameSession - Reserve Session – Ylands
Jump to navigation
Jump to search
(Created page with " ---- {{Ylands scripting navbox}} {{DEFAULTSORT:{{#sub:{{PAGENAME}}|14}}}} Category: Instructions Category: Ylands 0.15") |
No edit summary |
||
| Line 1: | Line 1: | ||
[[Image:{{PAGENAME}}.png]] | |||
*Instructions allowing to transfer players between [[Ylands Game set|'''Game set''']] games. | |||
===Reserve session=== | |||
*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''']] | |||
**'''Players''' - list of player ([[Ylands Tile category - Array|Array]]) to be transfered. | |||
*This instruction will try to reserve a game session, if free game instance is available. | |||
**Game instance = game running on official dedicated server. | |||
**Target instances are chosen automatically. | |||
**If there wont be any instances running, new instances will be spawned automatically. | |||
*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 [[Ylands Tile - Reservation fail type|'''coresponding enumerator''']]. | |||
===Example=== | |||
<gallery> | |||
Image: Ylands-Game-set-session-2.png|Example | |||
</gallery> | |||
---- | ---- | ||
Revision as of 15:22, 13 January 2020
File:Tile - YGameSession - Reserve Session.png
- Instructions allowing to transfer players between Game set games.
Reserve session
- In order to reserve session, following input parameters has to be entered
- Guid - Game ID obtained via Game set manager
- Players - list of player (Array) to be transfered.
- This instruction will try to reserve a game session, if free game instance is available.
- Game instance = game running on official dedicated server.
- Target instances are chosen automatically.
- If there wont be any instances running, new instances will be spawned automatically.
- 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
