Main Server
Only available in the GodotSteam Server branches
Functions
isServerSecure
isServerSecure()
No official notes, but should be checking if the server is secured.
Returns: bool
getServerSteamID
getServerSteamID()
Gets the server's Steam ID.
Returns: uint64_t
serverInit
serverInit( string ip, uint16 game_port, uint16 query_port, int server_mode, string version_number )
Initialize SteamGameServer client and interface objects, and set server properties which may not be changed.
After calling this function, you should set any additional server parameters, and then logOnAnonymous() or logOn().
Returns: bool
serverInitEx
serverInitEx( string ip, uint16 game_port, uint16 query_port, int server_mode, string version_number )
Initialize SteamGameServer client and interface objects, and set server properties which may not be changed.
After calling this function, you should set any additional server parameters, and then logOnAnonymous() or logOn().
On success STEAM_API_INIT_RESULT_OK is returned. Otherwise, if error_message is non-NULL, it will receive a non-localized message that explains the reason for the failure.
Returns: dictionary
- status (int)
- verbal (string)
You will receive one of these results:
- 0 / "Steamworks active"
- 1 / "Failed (generic)"
- 2 / "Cannot connect to Steam, client probably isn't running"
- 3 / "Steam client appears to be out of date"
serverReleaseCurrentThreadMemory
serverReleaseCurrentThreadMemory()
Frees all API-related memory associated with the calling thread. This memory is released automatically by RunCallbacks so single-threaded servers do not need to call this.
serverShutdown
serverShutdown()
Shut down the server connection to Steam.
Enums
AccountType
| Enumerator | Value |
|---|---|
| ACCOUNT_TYPE_INVALID | 0 |
| ACCOUNT_TYPE_INDIVIDUAL | 1 |
| ACCOUNT_TYPE_MULTISEAT | 2 |
| ACCOUNT_TYPE_GAME_SERVER | 3 |
| ACCOUNT_TYPE_ANON_GAME_SERVER | 4 |
| ACCOUNT_TYPE_PENDING | 5 |
| ACCOUNT_TYPE_CONTENT_SERVER | 6 |
| ACCOUNT_TYPE_CLAN | 7 |
| ACCOUNT_TYPE_CHAT | 8 |
| ACCOUNT_TYPE_CONSOLE_USER | 9 |
| ACCOUNT_TYPE_ANON_USER | 10 |
| ACCOUNT_TYPE_MAX | 11 |
AuthSessionResponse
| Enumerator | Value |
|---|---|
| AUTH_SESSION_RESPONSE_OK | 0 |
| AUTH_SESSION_RESPONSE_USER_NOT_CONNECTED_TO_STEAM | 1 |
| AUTH_SESSION_RESPONSE_NO_LICENSE_OR_EXPIRED | 2 |
| AUTH_SESSION_RESPONSE_VAC_BANNED | 3 |
| AUTH_SESSION_RESPONSE_LOGGED_IN_ELSEWHERE | 4 |
| AUTH_SESSION_RESPONSE_VAC_CHECK_TIMEDOUT | 5 |
| AUTH_SESSION_RESPONSE_AUTH_TICKET_CANCELED | 6 |
| AUTH_SESSION_RESPONSE_AUTH_TICKET_INVALID_ALREADY_USED | 7 |
| AUTH_SESSION_RESPONSE_AUTH_TICKET_INVALID | 8 |
| AUTH_SESSION_RESPONSE_PUBLISHER_ISSUED_BAN | 9 |
BeginAuthSessionResult
| Enumerator | Value |
|---|---|
| BEGIN_AUTH_SESSION_RESULT_OK | 0 |
| BEGIN_AUTH_SESSION_RESULT_INVALID_TICKET | 1 |
| BEGIN_AUTH_SESSION_RESULT_DUPLICATE_REQUEST | 2 |
| BEGIN_AUTH_SESSION_RESULT_INVALID_VERSION | 3 |
| BEGIN_AUTH_SESSION_RESULT_GAME_MISMATCH | 4 |
| BEGIN_AUTH_SESSION_RESULT_EXPIRED_TICKET | 5 |
DenyReason
| Enumerator | Value |
|---|---|
| DENY_INVALID | 0 |
| DENY_INVALID_VERSION | 1 |
| DENY_GENERIC | 2 |
| DENY_NOT_LOGGED_ON | 3 |
| DENY_NO_LICENSE | 4 |
| DENY_CHEATER | 5 |
| DENY_LOGGED_IN_ELSEWHERE | 6 |
| DENY_UNKNOWN_TEXT | 7 |
| DENY_INCOMPATIBLE_ANTI_CHEAT | 8 |
| DENY_MEMORY_CORRUPTION | 9 |
| DENY_INCOMPATIBLE_SOFTWARE | 10 |
| DENY_STEAM_CONNECTION_LOST | 11 |
| DENY_STEAM_CONNECTION_ERROR | 12 |
| DENY_STEAM_RESPONSE_TIMED_OUT | 13 |
| DENY_STEAM_VALIDATION_STALLED | 14 |
| DENY_STEAM_OWNER_LEFT_GUEST_USER | 15 |
GameIDType
| Enumerator | Value |
|---|---|
| GAME_TYPE_APP | 0 |
| GAME_TYPE_GAME_MOD | 1 |
| GAME_TYPE_SHORTCUT | 2 |
| GAME_TYPE_P2P | 3 |
Result
| Enumerator | Value |
|---|---|
| RESULT_OK | 1 |
| RESULT_FAIL | 2 |
| RESULT_NO_CONNECTION | 3 |
| RESULT_INVALID_PASSWORD | 5 |
| RESULT_LOGGED_IN_ELSEWHERE | 6 |
| RESULT_INVALID_PROTOCOL_VER | 7 |
| RESULT_INVALID_PARAM | 8 |
| RESULT_FILE_NOT_FOUND | 9 |
| RESULT_BUSY | 10 |
| RESULT_INVALID_STATE | 11 |
| RESULT_INVALID_NAME | 12 |
| RESULT_INVALID_EMAIL | 13 |
| RESULT_DUPLICATE_NAME | 14 |
| RESULT_ACCESS_DENIED | 15 |
| RESULT_TIMEOUT | 16 |
| RESULT_BANNED | 17 |
| RESULT_ACCOUNT_NOT_FOUND | 18 |
| RESULT_INVALID_STEAM_ID | 19 |
| RESULT_SERVICE_UNAVAILABLE | 20 |
| RESULT_NOT_LOGGED_ON | 21 |
| RESULT_PENDING | 22 |
| RESULT_ENCRYPTION_FAILURE | 23 |
| RESULT_INSUFFICIENT_PRIVILEGE | 24 |
| RESULT_LIMIT_EXCEEDED | 25 |
| RESULT_REVOKED | 26 |
| RESULT_EXPIRED | 27 |
| RESULT_ALREADY_REDEEMED | 28 |
| RESULT_DUPLICATE_REQUEST | 29 |
| RESULT_ALREADY_OWNED | 30 |
| RESULT_IP_NOT_FOUND | 31 |
| RESULT_PERSIST_FAILED | 32 |
| RESULT_LOCKING_FAILED | 33 |
| RESULT_LOG_ON_SESSION_REPLACED | 34 |
| RESULT_CONNECT_FAILED | 35 |
| RESULT_HANDSHAKE_FAILED | 36 |
| RESULT_IO_FAILURE | 37 |
| RESULT_REMOTE_DISCONNECT | 38 |
| RESULT_SHOPPING_CART_NOT_FOUND | 39 |
| RESULT_BLOCKED | 40 |
| RESULT_IGNORED | 41 |
| RESULT_NO_MATCH | 42 |
| RESULT_ACCOUNT_DISABLED | 43 |
| RESULT_SERVICE_READ_ONLY | 44 |
| RESULT_ACCOUNT_NOT_FEATURED | 45 |
| RESULT_ADMINISTRATOR_OK | 46 |
| RESULT_CONTENT_VERSION | 47 |
| RESULT_TRY_ANOTHER_CM | 48 |
| RESULT_PASSWORD_REQUIRED_TO_KICK_SESSION | 49 |
| RESULT_ALREADY_LOGGED_IN_ELSEWHERE | 50 |
| RESULT_SUSPENDED | 51 |
| RESULT_CANCELLED | 52 |
| RESULT_DATA_CORRUPTION | 53 |
| RESULT_DISK_FULL | 54 |
| RESULT_REMOTE_CALL_FAILED | 55 |
| RESULT_PASSWORD_UNSET | 56 |
| RESULT_EXTERNAL_ACCOUNT_UNLINKED | 57 |
| RESULT_PSN_TICKET_INVALID | 58 |
| RESULT_EXTERNAL_ACCOUNT_ALREADY_LINKED | 59 |
| RESULT_REMOTE_FILE_CONFLICT | 60 |
| RESULT_ILLEGAL_PASSWORD | 61 |
| RESULT_SAME_AS_PREVIOUS_VALUE | 62 |
| RESULT_ACCOUNT_LOG_ON_DENIED | 63 |
| RESULT_CANNOT_USE_OLD_PASSWORD | 64 |
| RESULT_INVALID_LOGIN_AUTH_CODE | 65 |
| RESULT_ACCOUNT_LOG_ON_DENIED_NO_MAIL | 66 |
| RESULT_HARDWARE_NOT_CAPABLE_OF_IPT | 67 |
| RESULT_IPT_INIT_ERROR | 68 |
| RESULT_PARENTAL_CONTROL_RESTRICTED | 69 |
| RESULT_FACEBOOK_QUERY_ERROR | 70 |
| RESULT_EXPIRED_LOGIN_AUTH_CODE | 71 |
| RESULT_IP_LOGIN_RESTRICTION_FAILED | 72 |
| RESULT_ACCOUNT_LOCKED_DOWN | 73 |
| RESULT_ACCOUNT_LOG_ON_DENIED_VERIFIED_EMAIL_REQUIRED | 74 |
| RESULT_NO_MATCHING_URL | 75 |
| RESULT_BAD_RESPONSE | 76 |
| RESULT_REQUIRE_PASSWORD_REENTRY | 77 |
| RESULT_VALUE_OUT_OF_RANGE | 78 |
| RESULT_UNEXPECTED_ERROR | 79 |
| RESULT_DISABLED | 80 |
| RESULT_INVALID_CEG_SUBMISSION | 81 |
| RESULT_RESTRICTED_DEVICE | 82 |
| RESULT_REGION_LOCKED | 83 |
| RESULT_RATE_LIMIT_EXCEEDED | 84 |
| RESULT_ACCOUNT_LOGIN_DENIED_NEED_TWO_FACTOR | 85 |
| RESULT_ITEM_DELETED | 86 |
| RESULT_ACCOUNT_LOGIN_DENIED_THROTTLE | 87 |
| RESULT_TWO_FACTOR_CODE_MISMATCH | 88 |
| RESULT_TWO_FACTOR_ACTIVATION_CODE_MISMATCH | 89 |
| RESULT_ACCOUNT_ASSOCIATED_TO_MULTIPLE_PARTNERS | 90 |
| RESULT_NOT_MODIFIED | 91 |
| RESULT_NO_MOBILE_DEVICE | 92 |
| RESULT_TIME_NOT_SYNCED | 93 |
| RESULT_SMS_CODE_FAILED | 94 |
| RESULT_ACCOUNT_LIMIT_EXCEEDED | 95 |
| RESULT_ACCOUNT_ACTIVITY_LIMIT_EXCEEDED | 96 |
| RESULT_PHONE_ACTIVITY_LIMIT_EXCEEDED | 97 |
| RESULT_REFUND_TO_WALLET | 98 |
| RESULT_EMAIL_SEND_FAILURE | 99 |
| RESULT_NOT_SETTLED | 100 |
| RESULT_NEED_CAPTCHA | 101 |
| RESULT_GSLT_DENIED | 102 |
| RESULT_GS_OWNER_DENIED | 103 |
| RESULT_INVALID_ITEM_TYPE | 104 |
| RESULT_IP_BANNED | 105 |
| RESULT_GSLT_EXPIRED | 106 |
| RESULT_INSUFFICIENT_FUNDS | 107 |
| RESULT_TOO_MANY_PENDING | 108 |
ServerMode
| Enumerator | Value |
|---|---|
| SERVER_MODE_INVALID | 0 |
| SERVER_MODE_NO_AUTHENTICATION | 1 |
| SERVER_MODE_AUTHENTICATION | 2 |
| SERVER_MODE_AUTHENTICATION_AND_SECURE | 3 |
SteamAPIInitResult
| Enumerator | Value |
|---|---|
| STEAM_API_INIT_RESULT_OK | 0 |
| STEAM_API_INIT_RESULT_FAILED_GENERIC | 1 |
| STEAM_API_INIT_RESULT_NO_STEAM_CLIENT | 2 |
| STEAM_API_INIT_RESULT_VERSION_MISMATCH | 3 |
Universe
| Enumerator | Value |
|---|---|
| UNIVERSE_INVALID | 0 |
| UNIVERSE_PUBLIC | 1 |
| UNIVERSE_BETA | 2 |
| UNIVERSE_INTERNAL | 3 |
| UNIVERSE_DEV | 4 |
| UNIVERSE_MAX | 5 |