Options
All
  • Public
  • Public/Protected
  • All
Menu

Class YGameSession

Hierarchy

  • YGameSession

Index

Constructors

constructor

Methods

Static dispatchReservedSession

  • Allows to dispatch the session reserved in matchmaking.

    Parameters

    Returns void

Static enablePlayerJoin

  • enablePlayerJoin(enable: boolean): void
  • Allows to enable / disable whenever any new players can join currently running multiplayer game.

    Parameters

    • enable: boolean

    Returns void

Static endGame

  • endGame(): void
  • Ends the game and shutdowns the server.

    Returns void

Static getPlayers

  • Returns a list of players connected to a multiplayer session.

    Parameters

    • onlineOnly: boolean

    Returns YCharacter[]

Static isMobileOnlyServer

  • isMobileOnlyServer(): boolean
  • Returns whether the server allows Mobile players exclusively or not.

    Returns boolean

Static matchmakingCancel

  • This instruction will cancel the current Matchmaker* request.

    Parameters

    Returns void

Static matchmakingGetReserveGameId

  • Returns the Game ID of game where the player can be dispatched to.

    Parameters

    Returns string

Static matchmakingStart

Static reserveSession

Static restartGame

  • restartGame(rejoinPlayers: boolean): void
  • restartGame(playersToRejoin: YCharacter[]): void
  • Restarts currently running game. In multiplayer, it will disconnect all players and restart the server.

    Parameters

    • rejoinPlayers: boolean

    Returns void

  • Allows to restart currently running game and rejoin selected players.

    Parameters

    Returns void

Static sendMessageToClient

  • Allows to send an event to client script.

    Parameters

    Returns void

Generated using TypeDoc