SetServerProperties

Method

Set properties for the current server. Server properties persist with the server instance until the server is closed, which happens when the last actor disconnects from the server. This only works if actively connected to the server. Check for isConnected before calling this.

Remarks

Supported types: string, int, bool Property names validation rule: a-z, A-Z, 0-9, _ and and only starting with letters, and must be maximum 10 characters long. Additionally, it is recommended to keep property names as short as possible, as they are broadcasted as bare strings, which can increase network traffic.

Definition

void SetServerProperties(IReadOnlyCollection<KeyValuePair<string, object>> properties)
void SetServerProperties(IReadOnlyCollection<KeyValuePair<string, object>> properties)

Parameters

ParameterDescription
IReadOnlyCollection<KeyValuePair<string, object>> properties

Dictionary of properties to set (string, int, bool)