C# Class Steamworks.SteamGameServer

Mostrar archivo Open project: rlabrecque/Steamworks.NET Class Usage Examples

Public Methods

Method Description
AssociateWithClan ( CSteamID steamIDClan ) : SteamAPICall_t

associate this game server with this clan for the purposes of computing player compat

BLoggedOn ( ) : bool

status functions

BSecure ( ) : bool
BUpdateUserData ( CSteamID steamIDUser, string pchPlayerName, uint uScore ) : bool

Update the data to be displayed in the server browser and matchmaking interfaces for a user

currently connected to the server. For regular users you must call this after you receive a

GSUserValidationSuccess callback.

Return Value: true if successful, false if failure (ie, steamIDUser wasn't for an active player)

BeginAuthSession ( byte pAuthTicket, int cbAuthTicket, CSteamID steamID ) : EBeginAuthSessionResult

Authenticate ticket ( from GetAuthSessionTicket ) from entity steamID to be sure it is valid and isnt reused

Registers for callbacks if the entity goes offline or cancels the ticket ( see ValidateAuthTicketResponse_t callback and EAuthSessionResponse )

CancelAuthTicket ( HAuthTicket hAuthTicket ) : void

Cancel auth ticket from GetAuthSessionTicket, called when no longer playing game with the entity you gave the ticket to

ClearAllKeyValues ( ) : void

/ Call this to clear the whole list of key/values that are sent in rules queries.

ComputeNewPlayerCompatibility ( CSteamID steamIDNewPlayer ) : SteamAPICall_t

ask if any of the current players dont want to play with this new player - or vice versa

CreateUnauthenticatedUserConnection ( ) : CSteamID

Creates a fake user (ie, a bot) which will be listed as playing on the server, but skips validation.

Return Value: Returns a SteamID for the user to be tracked with, you should call HandleUserDisconnect()

when this user leaves the server just like you would for a real user.

EnableHeartbeats ( bool bActive ) : void

Control heartbeats / advertisement with master server

Call this as often as you like to tell the master server updater whether or not

you want it to be active (default: off).

EndAuthSession ( CSteamID steamID ) : void

Stop tracking started by BeginAuthSession - called when no longer playing game with this entity

ForceHeartbeat ( ) : void

Force a heartbeat to steam at the next opportunity

GetAuthSessionTicket ( byte pTicket, int cbMaxTicket, uint &pcbTicket ) : HAuthTicket

New auth system APIs - do not mix with the old auth system APIs.

----------------------------------------------------------------

Retrieve ticket to be sent to the entity who wishes to authenticate you ( using BeginAuthSession API ).

pcbTicket retrieves the length of the actual ticket.

GetGameplayStats ( ) : void

these two functions s are deprecated, and will not return results

they will be removed in a future version of the SDK

GetNextOutgoingPacket ( byte pOut, int cbMaxOut, uint &pNetAdr, ushort &pPort ) : int

AFTER calling HandleIncomingPacket for any packets that came in that frame, call this.

This gets a packet that the master server updater needs to send out on UDP.

It returns the length of the packet it wants to send, or 0 if there are no more packets to send.

Call this each frame until it returns 0.

GetPublicIP ( ) : uint

Returns the public IP of the server according to Steam, useful when the server is

behind NAT and you want to advertise its IP in a lobby for other clients to directly

connect to

GetServerReputation ( ) : SteamAPICall_t
GetSteamID ( ) : CSteamID
HandleIncomingPacket ( byte pData, int cbData, uint srcIP, ushort srcPort ) : bool

These are in GameSocketShare mode, where instead of ISteamGameServer creating its own

socket to talk to the master server on, it lets the game use its socket to forward messages

back and forth. This prevents us from requiring server ops to open up yet another port

in their firewalls.

the IP address and port should be in host order, i.e 127.0.0.1 == 0x7f000001

These are used when you've elected to multiplex the game server's UDP socket

rather than having the master server updater use its own sockets.

Source games use this to simplify the job of the server admins, so they

don't have to open up more ports on their firewalls.

Call this when a packet that starts with 0xFFFFFFFF comes in. That means

it's for us.

InitGameServer ( uint unIP, ushort usGamePort, ushort usQueryPort, uint unFlags, AppId_t nGameAppId, string pchVersionString ) : bool

Basic server data. These properties, if set, must be set before before calling LogOn. They

may not be changed after logged in.

/ This is called by SteamGameServer_Init, and you will usually not need to call it directly

LogOff ( ) : void

/ Begin process of logging game server out of steam

LogOn ( string pszToken ) : void

Login

/ Begin process to login to a persistent game server account

/

/ You need to register for callbacks to determine the result of this operation.

/ @see SteamServersConnected_t

/ @see SteamServerConnectFailure_t

/ @see SteamServersDisconnected_t

LogOnAnonymous ( ) : void

/ Login to a generic, anonymous account.

/

/ Note: in previous versions of the SDK, this was automatically called within SteamGameServer_Init,

/ but this is no longer the case.

RequestUserGroupStatus ( CSteamID steamIDUser, CSteamID steamIDGroup ) : bool

Ask if a user in in the specified group, results returns async by GSUserGroupStatus_t

returns false if we're not connected to the steam servers and thus cannot ask

SendUserConnectAndAuthenticate ( uint unIPClient, byte pvAuthBlob, uint cubAuthBlobSize, CSteamID &pSteamIDUser ) : bool

Player list management / authentication

Handles receiving a new connection from a Steam user. This call will ask the Steam

servers to validate the users identity, app ownership, and VAC status. If the Steam servers

are off-line, then it will validate the cached ticket itself which will validate app ownership

and identity. The AuthBlob here should be acquired on the game client using SteamUser()->InitiateGameConnection()

and must then be sent up to the game server for authentication.

Return Value: returns true if the users ticket passes basic checks. pSteamIDUser will contain the Steam ID of this user. pSteamIDUser must NOT be NULL

If the call succeeds then you should expect a GSClientApprove_t or GSClientDeny_t callback which will tell you whether authentication

for the user has succeeded or failed (the steamid in the callback will match the one returned by this call)

SendUserDisconnect ( CSteamID steamIDUser ) : void

Should be called whenever a user leaves our game server, this lets Steam internally

track which users are currently on which servers for the purposes of preventing a single

account being logged into multiple servers, showing who is currently on a server, etc.

SetBotPlayerCount ( int cBotplayers ) : void

/ Number of bots. Default value is zero

SetDedicatedServer ( bool bDedicated ) : void

/ Is this is a dedicated server? The default value is false.

SetGameData ( string pchGameData ) : void

/ Sets a string defining the "gamedata" for this server, this is optional, but if it is set

/ it allows users to filter in the matchmaking/server-browser interfaces based on the value

/ don't set this unless it actually changes, its only uploaded to the master once (when

/ acknowledged)

/

/ @see k_cbMaxGameServerGameData

SetGameDescription ( string pszGameDescription ) : void

/ Description of the game. This is a required field and is displayed in the steam server browser....for now.

/ This is a required field, but it will go away eventually, as the data should be determined from the AppID.

SetGameTags ( string pchGameTags ) : void

/ Sets a string defining the "gametags" for this server, this is optional, but if it is set

/ it allows users to filter in the matchmaking/server-browser interfaces based on the value

/

/ @see k_cbMaxGameServerTags

SetHeartbeatInterval ( int iHeartbeatInterval ) : void

You usually don't need to modify this.

Pass -1 to use the default value for iHeartbeatInterval.

Some mods change this.

SetKeyValue ( string pKey, string pValue ) : void

/ Call this to add/update a key/value pair.

SetMapName ( string pszMapName ) : void

/ Set name of map to report in the server browser

/

/ @see k_cbMaxGameServerName

SetMaxPlayerCount ( int cPlayersMax ) : void

Server state. These properties may be changed at any time.

/ Max player count that will be reported to server browser and client queries

SetModDir ( string pszModDir ) : void

/ If your game is a "mod," pass the string that identifies it. The default is an empty string, meaning

/ this application is the original game, not a mod.

/

/ @see k_cbMaxGameServerGameDir

SetPasswordProtected ( bool bPasswordProtected ) : void

/ Let people know if your server will require a password

SetProduct ( string pszProduct ) : void

/ Game product identifier. This is currently used by the master server for version checking purposes.

/ It's a required field, but will eventually will go away, and the AppID will be used for this purpose.

SetRegion ( string pszRegion ) : void

/ Region identifier. This is an optional field, the default value is empty, meaning the "world" region

SetServerName ( string pszServerName ) : void

/ Set the name of server as it will appear in the server browser

/

/ @see k_cbMaxGameServerName

SetSpectatorPort ( ushort unSpectatorPort ) : void

/ Spectator server. The default value is zero, meaning the service

/ is not used.

SetSpectatorServerName ( string pszSpectatorServerName ) : void

/ Name of the spectator server. (Only used if spectator port is nonzero.)

/

/ @see k_cbMaxGameServerMapName

UserHasLicenseForApp ( CSteamID steamID, AppId_t appID ) : EUserHasLicenseForAppResult

After receiving a user's authentication data, and passing it to SendUserConnectAndAuthenticate, use this function

to determine if the user owns downloadable content specified by the provided AppID.

WasRestartRequested ( ) : bool

/ Returns true if the master server has requested a restart.

/ Only returns true once per request.

Method Details

AssociateWithClan() public static method

associate this game server with this clan for the purposes of computing player compat

public static AssociateWithClan ( CSteamID steamIDClan ) : SteamAPICall_t
steamIDClan CSteamID
return SteamAPICall_t

BLoggedOn() public static method

status functions

public static BLoggedOn ( ) : bool
return bool

BSecure() public static method

public static BSecure ( ) : bool
return bool

BUpdateUserData() public static method

Update the data to be displayed in the server browser and matchmaking interfaces for a user

currently connected to the server. For regular users you must call this after you receive a

GSUserValidationSuccess callback.

Return Value: true if successful, false if failure (ie, steamIDUser wasn't for an active player)

public static BUpdateUserData ( CSteamID steamIDUser, string pchPlayerName, uint uScore ) : bool
steamIDUser CSteamID
pchPlayerName string
uScore uint
return bool

BeginAuthSession() public static method

Authenticate ticket ( from GetAuthSessionTicket ) from entity steamID to be sure it is valid and isnt reused

Registers for callbacks if the entity goes offline or cancels the ticket ( see ValidateAuthTicketResponse_t callback and EAuthSessionResponse )

public static BeginAuthSession ( byte pAuthTicket, int cbAuthTicket, CSteamID steamID ) : EBeginAuthSessionResult
pAuthTicket byte
cbAuthTicket int
steamID CSteamID
return EBeginAuthSessionResult

CancelAuthTicket() public static method

Cancel auth ticket from GetAuthSessionTicket, called when no longer playing game with the entity you gave the ticket to

public static CancelAuthTicket ( HAuthTicket hAuthTicket ) : void
hAuthTicket HAuthTicket
return void

ClearAllKeyValues() public static method

/ Call this to clear the whole list of key/values that are sent in rules queries.

public static ClearAllKeyValues ( ) : void
return void

ComputeNewPlayerCompatibility() public static method

ask if any of the current players dont want to play with this new player - or vice versa

public static ComputeNewPlayerCompatibility ( CSteamID steamIDNewPlayer ) : SteamAPICall_t
steamIDNewPlayer CSteamID
return SteamAPICall_t

CreateUnauthenticatedUserConnection() public static method

Creates a fake user (ie, a bot) which will be listed as playing on the server, but skips validation.

Return Value: Returns a SteamID for the user to be tracked with, you should call HandleUserDisconnect()

when this user leaves the server just like you would for a real user.

public static CreateUnauthenticatedUserConnection ( ) : CSteamID
return CSteamID

EnableHeartbeats() public static method

Control heartbeats / advertisement with master server

Call this as often as you like to tell the master server updater whether or not

you want it to be active (default: off).

public static EnableHeartbeats ( bool bActive ) : void
bActive bool
return void

EndAuthSession() public static method

Stop tracking started by BeginAuthSession - called when no longer playing game with this entity

public static EndAuthSession ( CSteamID steamID ) : void
steamID CSteamID
return void

ForceHeartbeat() public static method

Force a heartbeat to steam at the next opportunity

public static ForceHeartbeat ( ) : void
return void

GetAuthSessionTicket() public static method

New auth system APIs - do not mix with the old auth system APIs.

----------------------------------------------------------------

Retrieve ticket to be sent to the entity who wishes to authenticate you ( using BeginAuthSession API ).

pcbTicket retrieves the length of the actual ticket.

public static GetAuthSessionTicket ( byte pTicket, int cbMaxTicket, uint &pcbTicket ) : HAuthTicket
pTicket byte
cbMaxTicket int
pcbTicket uint
return HAuthTicket

GetGameplayStats() public static method

these two functions s are deprecated, and will not return results

they will be removed in a future version of the SDK

public static GetGameplayStats ( ) : void
return void

GetNextOutgoingPacket() public static method

AFTER calling HandleIncomingPacket for any packets that came in that frame, call this.

This gets a packet that the master server updater needs to send out on UDP.

It returns the length of the packet it wants to send, or 0 if there are no more packets to send.

Call this each frame until it returns 0.

public static GetNextOutgoingPacket ( byte pOut, int cbMaxOut, uint &pNetAdr, ushort &pPort ) : int
pOut byte
cbMaxOut int
pNetAdr uint
pPort ushort
return int

GetPublicIP() public static method

Returns the public IP of the server according to Steam, useful when the server is

behind NAT and you want to advertise its IP in a lobby for other clients to directly

connect to

public static GetPublicIP ( ) : uint
return uint

GetServerReputation() public static method

public static GetServerReputation ( ) : SteamAPICall_t
return SteamAPICall_t

GetSteamID() public static method

public static GetSteamID ( ) : CSteamID
return CSteamID

HandleIncomingPacket() public static method

These are in GameSocketShare mode, where instead of ISteamGameServer creating its own

socket to talk to the master server on, it lets the game use its socket to forward messages

back and forth. This prevents us from requiring server ops to open up yet another port

in their firewalls.

the IP address and port should be in host order, i.e 127.0.0.1 == 0x7f000001

These are used when you've elected to multiplex the game server's UDP socket

rather than having the master server updater use its own sockets.

Source games use this to simplify the job of the server admins, so they

don't have to open up more ports on their firewalls.

Call this when a packet that starts with 0xFFFFFFFF comes in. That means

it's for us.

public static HandleIncomingPacket ( byte pData, int cbData, uint srcIP, ushort srcPort ) : bool
pData byte
cbData int
srcIP uint
srcPort ushort
return bool

InitGameServer() public static method

Basic server data. These properties, if set, must be set before before calling LogOn. They

may not be changed after logged in.

/ This is called by SteamGameServer_Init, and you will usually not need to call it directly

public static InitGameServer ( uint unIP, ushort usGamePort, ushort usQueryPort, uint unFlags, AppId_t nGameAppId, string pchVersionString ) : bool
unIP uint
usGamePort ushort
usQueryPort ushort
unFlags uint
nGameAppId AppId_t
pchVersionString string
return bool

LogOff() public static method

/ Begin process of logging game server out of steam

public static LogOff ( ) : void
return void

LogOn() public static method

Login

/ Begin process to login to a persistent game server account

/

/ You need to register for callbacks to determine the result of this operation.

/ @see SteamServersConnected_t

/ @see SteamServerConnectFailure_t

/ @see SteamServersDisconnected_t

public static LogOn ( string pszToken ) : void
pszToken string
return void

LogOnAnonymous() public static method

/ Login to a generic, anonymous account.

/

/ Note: in previous versions of the SDK, this was automatically called within SteamGameServer_Init,

/ but this is no longer the case.

public static LogOnAnonymous ( ) : void
return void

RequestUserGroupStatus() public static method

Ask if a user in in the specified group, results returns async by GSUserGroupStatus_t

returns false if we're not connected to the steam servers and thus cannot ask

public static RequestUserGroupStatus ( CSteamID steamIDUser, CSteamID steamIDGroup ) : bool
steamIDUser CSteamID
steamIDGroup CSteamID
return bool

SendUserConnectAndAuthenticate() public static method

Player list management / authentication

Handles receiving a new connection from a Steam user. This call will ask the Steam

servers to validate the users identity, app ownership, and VAC status. If the Steam servers

are off-line, then it will validate the cached ticket itself which will validate app ownership

and identity. The AuthBlob here should be acquired on the game client using SteamUser()->InitiateGameConnection()

and must then be sent up to the game server for authentication.

Return Value: returns true if the users ticket passes basic checks. pSteamIDUser will contain the Steam ID of this user. pSteamIDUser must NOT be NULL

If the call succeeds then you should expect a GSClientApprove_t or GSClientDeny_t callback which will tell you whether authentication

for the user has succeeded or failed (the steamid in the callback will match the one returned by this call)

public static SendUserConnectAndAuthenticate ( uint unIPClient, byte pvAuthBlob, uint cubAuthBlobSize, CSteamID &pSteamIDUser ) : bool
unIPClient uint
pvAuthBlob byte
cubAuthBlobSize uint
pSteamIDUser CSteamID
return bool

SendUserDisconnect() public static method

Should be called whenever a user leaves our game server, this lets Steam internally

track which users are currently on which servers for the purposes of preventing a single

account being logged into multiple servers, showing who is currently on a server, etc.

public static SendUserDisconnect ( CSteamID steamIDUser ) : void
steamIDUser CSteamID
return void

SetBotPlayerCount() public static method

/ Number of bots. Default value is zero

public static SetBotPlayerCount ( int cBotplayers ) : void
cBotplayers int
return void

SetDedicatedServer() public static method

/ Is this is a dedicated server? The default value is false.

public static SetDedicatedServer ( bool bDedicated ) : void
bDedicated bool
return void

SetGameData() public static method

/ Sets a string defining the "gamedata" for this server, this is optional, but if it is set

/ it allows users to filter in the matchmaking/server-browser interfaces based on the value

/ don't set this unless it actually changes, its only uploaded to the master once (when

/ acknowledged)

/

/ @see k_cbMaxGameServerGameData

public static SetGameData ( string pchGameData ) : void
pchGameData string
return void

SetGameDescription() public static method

/ Description of the game. This is a required field and is displayed in the steam server browser....for now.

/ This is a required field, but it will go away eventually, as the data should be determined from the AppID.

public static SetGameDescription ( string pszGameDescription ) : void
pszGameDescription string
return void

SetGameTags() public static method

/ Sets a string defining the "gametags" for this server, this is optional, but if it is set

/ it allows users to filter in the matchmaking/server-browser interfaces based on the value

/

/ @see k_cbMaxGameServerTags

public static SetGameTags ( string pchGameTags ) : void
pchGameTags string
return void

SetHeartbeatInterval() public static method

You usually don't need to modify this.

Pass -1 to use the default value for iHeartbeatInterval.

Some mods change this.

public static SetHeartbeatInterval ( int iHeartbeatInterval ) : void
iHeartbeatInterval int
return void

SetKeyValue() public static method

/ Call this to add/update a key/value pair.

public static SetKeyValue ( string pKey, string pValue ) : void
pKey string
pValue string
return void

SetMapName() public static method

/ Set name of map to report in the server browser

/

/ @see k_cbMaxGameServerName

public static SetMapName ( string pszMapName ) : void
pszMapName string
return void

SetMaxPlayerCount() public static method

Server state. These properties may be changed at any time.

/ Max player count that will be reported to server browser and client queries

public static SetMaxPlayerCount ( int cPlayersMax ) : void
cPlayersMax int
return void

SetModDir() public static method

/ If your game is a "mod," pass the string that identifies it. The default is an empty string, meaning

/ this application is the original game, not a mod.

/

/ @see k_cbMaxGameServerGameDir

public static SetModDir ( string pszModDir ) : void
pszModDir string
return void

SetPasswordProtected() public static method

/ Let people know if your server will require a password

public static SetPasswordProtected ( bool bPasswordProtected ) : void
bPasswordProtected bool
return void

SetProduct() public static method

/ Game product identifier. This is currently used by the master server for version checking purposes.

/ It's a required field, but will eventually will go away, and the AppID will be used for this purpose.

public static SetProduct ( string pszProduct ) : void
pszProduct string
return void

SetRegion() public static method

/ Region identifier. This is an optional field, the default value is empty, meaning the "world" region

public static SetRegion ( string pszRegion ) : void
pszRegion string
return void

SetServerName() public static method

/ Set the name of server as it will appear in the server browser

/

/ @see k_cbMaxGameServerName

public static SetServerName ( string pszServerName ) : void
pszServerName string
return void

SetSpectatorPort() public static method

/ Spectator server. The default value is zero, meaning the service

/ is not used.

public static SetSpectatorPort ( ushort unSpectatorPort ) : void
unSpectatorPort ushort
return void

SetSpectatorServerName() public static method

/ Name of the spectator server. (Only used if spectator port is nonzero.)

/

/ @see k_cbMaxGameServerMapName

public static SetSpectatorServerName ( string pszSpectatorServerName ) : void
pszSpectatorServerName string
return void

UserHasLicenseForApp() public static method

After receiving a user's authentication data, and passing it to SendUserConnectAndAuthenticate, use this function

to determine if the user owns downloadable content specified by the provided AppID.

public static UserHasLicenseForApp ( CSteamID steamID, AppId_t appID ) : EUserHasLicenseForAppResult
steamID CSteamID
appID AppId_t
return EUserHasLicenseForAppResult

WasRestartRequested() public static method

/ Returns true if the master server has requested a restart.

/ Only returns true once per request.

public static WasRestartRequested ( ) : bool
return bool