Tile - YGameSession - Get Reserved Game Id – 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 6: Line 6:
**The [[Ylands Matchmaking|'''Matchmaker''']] '''will not transfer''' player to already '''running instances'''.
**The [[Ylands Matchmaking|'''Matchmaker''']] '''will not transfer''' player to already '''running instances'''.


==Start Matchmaking==
== 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 18:
*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==
== Cancel matchmaking ==
*This instruction will '''cancel''' current [[Ylands Matchmaking|'''Matchmaker''']] request.
*This instruction will '''cancel''' current [[Ylands Matchmaking|'''Matchmaker''']] request.


==Dispatch session==
== Dispatch session ==
*This instruction will '''dispatch''' selected player using the '''Session object'''.
*This instruction will '''dispatch''' selected player 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 - Matchmaking fail type|'''corresponding enumerator''']].
*Can be compared with [[Ylands Tile - Matchmaking fail type|'''corresponding enumerator''']].


==Get reserved Game Id==
== 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==
== Example ==
<gallery>
<gallery>
Image: Ylands Tile - Matchmaking-example1.png|Example
Image: Ylands Tile - Matchmaking-example1.png|Example
</gallery>
</gallery>


==See also==
== See also ==
*[[Ylands Tile - Reserve game session|'''Reserve session''']]
*[[Ylands Tile - Reserve game session|'''Reserve session''']]
*[[Ylands Matchmaking|'''Matchmaking''']]
*[[Ylands Matchmaking|'''Matchmaking''']]

Revision as of 20:03, 31 January 2021

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

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

    Example

See also


Ylands - Editor
Editor

Animated objects, Custom UI, Entity welding, Game export, Game ID, Monetization, MIDI music, Optimizations, Common Problems, FAQ

Script

Introduction, Conventions, Client script, Text scripting, Custom controls, Custom controller, Storage Data, Game set, Leaderboards, Matchmaking, Map markers

Game logic

AI Behaviour, Ask Player, Controller, Custom Camera, Custom Controls, Custom HUD, Custom Window, Data Set, Dialogue, Entity Label, Entity Storage, Entity Template, Environment, Event Listener, Game Logic Label, Game Logic Storage, Game Logic Template, Global Storage, Group Template, Image Library, Impassable Barrier, Light, Melee Attack Effect, Particle Effect, Particle Template, Path, Play Area, Player Role, Player Team, Position Animator, Post Process, Reference Point, Resource, Rotation Animator, Script Module, Skill, Sound Effect, Spawn Point, Time Trigger, Transaction, Trigger Zone, Voice Chat Channel, Water Volume

Script tiles

Game, Entities, Game Logic, Logic, Loops, Instructions, Number, Vector, Color, String, Array

Misc

WIKI FAQ

Retrieved from "https://community.bistudio.com/wiki?title=Ylands:Tile_-_YGameSession_-_Get_Reserved_Game_Id&oldid=226419"