/AWS1/CL_GMLSERVERPROCESS¶
A set of instructions for launching server processes on fleet computes. Server processes run either an executable in a custom game build or a Amazon GameLift Servers Realtime script. Server process configurations are part of a fleet's runtime configuration.
CONSTRUCTOR
¶
IMPORTING¶
Required arguments:¶
iv_launchpath
TYPE /AWS1/GMLLAUNCHPATHSTRINGMODEL
/AWS1/GMLLAUNCHPATHSTRINGMODEL
¶
The location of a game build executable or Realtime script. Game builds and Realtime scripts are installed on instances at the root:
Windows (custom game builds only):
C:\game
. Example: "C:\game\MyGame\server.exe
"Linux:
/local/game
. Examples: "/local/game/MyGame/server.exe
" or "/local/game/MyRealtimeScript.js
"Amazon GameLift Servers doesn't support the use of setup scripts that launch the game executable. For custom game builds, this parameter must indicate the executable that calls the server SDK operations
initSDK()
andProcessReady()
.
iv_concurrentexecutions
TYPE /AWS1/GMLPOSITIVEINTEGER
/AWS1/GMLPOSITIVEINTEGER
¶
The number of server processes using this configuration that run concurrently on each instance or compute.
Optional arguments:¶
iv_parameters
TYPE /AWS1/GMLLAUNCHPARAMSSTRMODEL
/AWS1/GMLLAUNCHPARAMSSTRMODEL
¶
An optional list of parameters to pass to the server executable or Realtime script on launch.
Queryable Attributes¶
LaunchPath¶
The location of a game build executable or Realtime script. Game builds and Realtime scripts are installed on instances at the root:
Windows (custom game builds only):
C:\game
. Example: "C:\game\MyGame\server.exe
"Linux:
/local/game
. Examples: "/local/game/MyGame/server.exe
" or "/local/game/MyRealtimeScript.js
"Amazon GameLift Servers doesn't support the use of setup scripts that launch the game executable. For custom game builds, this parameter must indicate the executable that calls the server SDK operations
initSDK()
andProcessReady()
.
Accessible with the following methods¶
Method | Description |
---|---|
GET_LAUNCHPATH() |
Getter for LAUNCHPATH, with configurable default |
ASK_LAUNCHPATH() |
Getter for LAUNCHPATH w/ exceptions if field has no value |
HAS_LAUNCHPATH() |
Determine if LAUNCHPATH has a value |
Parameters¶
An optional list of parameters to pass to the server executable or Realtime script on launch.
Accessible with the following methods¶
Method | Description |
---|---|
GET_PARAMETERS() |
Getter for PARAMETERS, with configurable default |
ASK_PARAMETERS() |
Getter for PARAMETERS w/ exceptions if field has no value |
HAS_PARAMETERS() |
Determine if PARAMETERS has a value |
ConcurrentExecutions¶
The number of server processes using this configuration that run concurrently on each instance or compute.
Accessible with the following methods¶
Method | Description |
---|---|
GET_CONCURRENTEXECUTIONS() |
Getter for CONCURRENTEXECUTIONS, with configurable default |
ASK_CONCURRENTEXECUTIONS() |
Getter for CONCURRENTEXECUTIONS w/ exceptions if field has n |
HAS_CONCURRENTEXECUTIONS() |
Determine if CONCURRENTEXECUTIONS has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_SERVERPROCESSLIST
¶
TYPES TT_SERVERPROCESSLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_GMLSERVERPROCESS WITH DEFAULT KEY
.