Matchmaking – Ylands

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "[[Ylands " to "[[Ylands:")
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Image:{{PAGENAME}}.png]]
=Overview=
*Instructions allowing to transfer players between [[Ylands Game set|'''Game set''']] games.
Matchmaker is multiplayer feature, which allows to aggregate players from different servers and spawn for them new game instance. When a matchmaking session is requested for a player, he is then added to the matchmaker queue. After enough players are queued for same game, new server will be spawned for them.


===Reserve session===
*Players can queue only for games within the same [[Ylands:Game set|'''Game Set''']].
*If a '''free game instance''' is available, this instruction will try to reserve a '''game session''' for selected players.  
*When enough players are match-maked, new server starts
**Game instance = game running on official dedicated server.
**If there are not enough players for given time (aprox 2 minutes), the matchmaker will try start the server with minimum players.
**Target game instance is chosen automatically.
**Minimum / maximum players per servers is defined via game settings.
**If there wont be any instance available, new instance will be spawned automatically.
*Matchmaking is started via [[Ylands:Tile - Matchmaking|'''Start Matchmaking''']] instruction.
*In order to reserve session, following input parameters has to be entered
*Difference from [[Ylands:Tile - Reserve game session|'''Reserve Session''']] is, that players does not have to be on same server.
**'''Guid''' - [[Ylands Change Game ID|'''Game ID''']] obtained via [[Ylands Game set|'''Game set manager''']]
**'''Players''' - list of players ([[Ylands Tile category - Array|'''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===
<gallery>
*This instruction will '''dispatch''' selected players using the '''Session object'''.
Image: Ylands Matchmaking-Scheme.png|Matchmaking
</gallery>


===Fail reason===
== Notes ==
*Reason why the reservation has failed.
*In order for the game to be eligible for matchmaking, it has to be '''protected'''. Reason is that protected games are run on On demand servers which are part of the matchmaker network.
*Can be compared with [[Ylands Tile - Reservation fail type|'''coresponding enumerator''']].
 
== See also ==
*[[Ylands:Tile - Matchmaking|'''Start Matchmaking''']]
*[[Ylands:Tile - Reserve game session|'''Reserve session''']]
*[[Ylands:Game set|'''Game set''']]


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




----
----
{{Ylands scripting navbox}}
{{Navbox/Ylands}}
{{DEFAULTSORT:{{#sub:{{PAGENAME}}|14}}}}
{{DEFAULTSORT:{{#sub:{{PAGENAME}}|7}}}}


[[Category: Instructions]]
[[Category: Script: How To]]
[[Category: Ylands 1.4]]

Latest revision as of 17:36, 16 November 2022

Overview

Matchmaker is multiplayer feature, which allows to aggregate players from different servers and spawn for them new game instance. When a matchmaking session is requested for a player, he is then added to the matchmaker queue. After enough players are queued for same game, new server will be spawned for them.

  • Players can queue only for games within the same Game Set.
  • When enough players are match-maked, new server starts
    • If there are not enough players for given time (aprox 2 minutes), the matchmaker will try start the server with minimum players.
    • Minimum / maximum players per servers is defined via game settings.
  • Matchmaking is started via Start Matchmaking instruction.
  • Difference from Reserve Session is, that players does not have to be on same server.

Notes

  • In order for the game to be eligible for matchmaking, it has to be protected. Reason is that protected games are run on On demand servers which are part of the matchmaker network.

See also