• Studio

  • Bots

  • Web API

  • Designer Resources

  • Host Resources

  • GameServer

    In Highrise's scripting environment, the GameServer class acts as the high-level game context the script is running remotely. Any server-level interaction or manipulation will be found in this class. Specifically, scripts marked 'Server' or 'Client and Server' can access server - with 'Client and Server' scripts requiring you to check if server is not nil (or client is nil).

    Any high-level server events and interactions will be found in this type.

    Properties

    ServerOnly

    An event that is triggered when a new player gets connected to the game. This mechanism allows developers to trigger specific actions in response to a player's connection. Note that this is not when the player's Class.Avatar is spawned. For avatar spawn, see Class.Player when in a Class.GameClient side script.

    ServerOnly

    An event that is set off when a player disconnects from the game. This feature is crucial in managing actions that follow a player's disconnection.

    isLoading

    boolean

    Indicates whether the server is currently in a loading state.

    Methods

    ServerOnly

    Loads a scene into the game environment.

    Parameters

    sceneNameOrId

    string or number

    additive

    boolean

    Returns

    ServerOnly

    Moves a player to a specified scene within the game environment.

    Parameters

    player
    Player
    scene
    Scene

    Returns

    boolean

    ServerOnly

    Loads a scene additively into the game environment.

    Parameters

    sceneNameOrId

    string or number

    Returns

    PocketWorlds Icon

    © 2024 Pocket Worlds. All rights reserved.