DSSession Interface Reference

DS server Session. More...

Public Member Functions
proto external string	Name ()
	Name of the the session.
proto external int	Status ()
	Status of the hosted instance (EDsSessionState)
proto external int	PlayerLimit ()
	Player limit on the instance.
proto external int	PlayerCount ()
	Player count on the instance.
proto external void	RequestShutdown ()
	Request termination of server.
proto external void	RequestActive ()
	Request server to enter active state.
proto external void	RequestFinish ()
	Request finishing of hosted session (game won, draw, canceled)
proto external void	RequestRestart ()
	Request restart of hosted session (with or without new parameters)
proto external float	GetUpTime ()
	Get current session uptime in seconds.
proto external string	RoomID ()
	ID of Room created on server.
proto external string	ScenarioID ()
	ID of Scenario hosted on server.

Detailed Description

DS server Session.

Member Function Documentation

GetUpTime()

proto external float DSSession.GetUpTime

(

)

Get current session uptime in seconds.

Name()

proto external string DSSession.Name

(

)

Name of the the session.

PlayerCount()

proto external int DSSession.PlayerCount

(

)

Player count on the instance.

PlayerLimit()

proto external int DSSession.PlayerLimit

(

)

Player limit on the instance.

RequestActive()

proto external void DSSession.RequestActive

(

)

Request server to enter active state.

RequestFinish()

proto external void DSSession.RequestFinish

(

)

Request finishing of hosted session (game won, draw, canceled)

RequestRestart()

proto external void DSSession.RequestRestart

(

)

Request restart of hosted session (with or without new parameters)

RequestShutdown()

proto external void DSSession.RequestShutdown

(

)

Request termination of server.

RoomID()

proto external string DSSession.RoomID

(

)

ID of Room created on server.

ScenarioID()

proto external string DSSession.ScenarioID

(

)

ID of Scenario hosted on server.

Status()

proto external int DSSession.Status

(

)

Status of the hosted instance (EDsSessionState)

---

The documentation for this interface was generated from the following file:

• GameLib/generated/online/DSSession.c