Session Templates
Version: 1.0.0.0 Updated: 2023-11-29 16:56:05
Summary
Documentation for the Session Templates Page
Session Templates Schema
| Name | Type | Required | Description |
|---|---|---|---|
| session_type | string | Yes | Unique name for this type of session |
| engine_session_type | string | Yes | The engine name for this session type |
| can_join_matchmaking | boolean | No | If sessions of this type can be entered into the matchmaking system |
| can_be_created_by_players | boolean | No | If players can create this session directly |
| publicly_joinable | boolean | No | If the session should be publicly joinable without invites |
| attempt_auto_join | boolean | No | Should we attempt to automatically join an existing session before creating a new one |
| default_public | boolean | No | If the session should be publicly joinable without invites |
| auto_add_to_browser | boolean | No | If the session should be automatically added to the public session browser |
| auto_browser_params | object | No | Parameters added to the session when it is automatically added to the public session browser |
| can_be_added_to_browser | boolean | No | Can this session type be added to the public session browser |
| keep_alive_on_empty | boolean | No | If the session should be kept alive when there are no players actively in it |
| auto_startup_params | object | No | See schema |
| min_session_count | integer | No | The minimum number of these sessions that should be kept alive at all times |
| default_num_teams | integer | No | Default number of teams this session type will have |
| default_players_per_team | integer | No | Default number of players allowed per team |
| can_player_change_team | boolean | No | Can a player change their own team without elevated permissions |
| custom_data | object | No | Custom passthrough data that will be added to all sessions of this type |
| sandbox_id | string | No | ID of the Sandbox |
| session_template_id | string | Yes | UUID to identify this specific session template |
| platform_session_templates | array | No | List of PlatformSessionTemplates that belong to this session type |
| last_modified_account_id | string | No | Account ID of the user who last modified the resource |
| last_modified_timestamp | string | No | Timestamp of when the resource was last modified |
Auto_startup_params Schema
| Name | Type | Required | Description |
|---|---|---|---|
| map | string | Yes | Name of the map for the instance to spawn with |
| mode | string | No | Game mode for the instance to spawn in |
| misc_params | string | No | Additional commandline parameters for the instance |
| custom_data | object | No | Custom data to pass through to the instance |