Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ProcessParameters

This data type contains the set of parameters sent to the GameLift service in a processReady() call.

Hierarchy

  • ProcessParameters

Index

Properties

Optional logParameters

logParameters: LogParameters

Object with a list of directory paths to game session log files.

Optional onHealthCheck

onHealthCheck: OnHealthCheckCallback

Callback function that the GameLift service calls to request a health status report from the server process.

GameLift calls this function every 60 seconds. After calling this function GameLift waits 60 seconds for a response, and if none is received. records the server process as unhealthy.

Optional onProcessTerminate

onProcessTerminate: OnProcessTerminateCallback

Callback function that the GameLift service calls to force the server process to shut down.

After calling this function, GameLift waits five minutes for the server process to shut down and respond with a processEnding call. If no response is received it shuts down the server process.

onStartGameSession

onStartGameSession: OnStartGameSessionCallback

Callback function that the GameLift service calls to activate a new game session.

GameLift calls this function in response to the client request CreateGameSession. The callback function passes a {@link GameSession} object.

Optional onUpdateGameSession

onUpdateGameSession: OnUpdateGameSessionCallback

Name of callback function that the GameLift service calls to provide an updated game session object.

GameLift calls this function once a match backfill request has been processed. It passes a {@link GameSession} object, a status update (updateReason), and the match backfill ticket ID.

port

port: number

Port number the server listens on for new player connections.

The value must fall into the port range configured for any fleet deploying this game server build. This port number is included in game session and player session objects, which game sessions use when connecting to a server process.

Generated using TypeDoc