Tile - YGameSession - Reserve Session – Ylands

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Ylands editor navbox}}" to "{{Navbox/Ylands}}")
m (Text replacement - " (={2,})([^ = ])(.*)([^ = ])(={2,}) * " to " $1 $2$3$4 $5 ")
Line 2: Line 2:
*Instructions allowing to transfer players between [[Ylands Game set|'''Game set''']] games.
*Instructions allowing to transfer players between [[Ylands Game set|'''Game set''']] games.


===Reserve session===
=== Reserve session ===
*If a '''free game instance''' is available, this instruction will try to reserve a '''game session''' for selected players.  
*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.
**Game instance = game running on official dedicated server.
Line 14: Line 14:
*If the reservation will fail, the instruction will return a '''Fail reason'''.
*If the reservation will fail, the instruction will return a '''Fail reason'''.


===Dispatch session===
=== Dispatch session ===
*This instruction will '''dispatch''' selected players using the '''Session object'''.
*This instruction will '''dispatch''' selected players using the '''Session object'''.


===Fail reason===
=== Fail reason ===
*Reason why the reservation has failed.
*Reason why the reservation has failed.
*Can be compared with [[Ylands Tile - Reservation fail type|'''coresponding enumerator''']].
*Can be compared with [[Ylands Tile - Reservation fail type|'''coresponding enumerator''']].


===Example===
=== Example ===
<gallery>
<gallery>
Image: Ylands-Game-set-session-2.png|Example
Image: Ylands-Game-set-session-2.png|Example
</gallery>
</gallery>


==See also==
== See also ==
*[[Ylands Tile - Matchmaking|'''Start Matchmaking''']]
*[[Ylands Tile - Matchmaking|'''Start Matchmaking''']]
*[[Ylands Matchmaking|'''Matchmaking''']]
*[[Ylands Matchmaking|'''Matchmaking''']]

Revision as of 20:09, 31 January 2021

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
  • 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

Example

See also