C# Class idTech4.Game.idBaseGame

ファイルを表示 Open project: iainmckay/idtech4.net

Public Methods

Method Description
CacheDictionaryMedia ( idDict dict ) : void

Caches media referenced from in key/value pairs in the given dictionary.

This is called after parsing an EntityDef and for each entity spawnArgs before merging the entitydef. It could be done post-merge, but that would avoid the fast pre-cache check associated with each entityDef.

Draw ( int clientIndex ) : bool
GetMapLoadingInterface ( string defaultInterface ) : string
GetTimeGroupTime ( int timeGroup ) : int

Used to manage divergent time-lines.
HandleGuiCommands ( string menuCommand ) : string

When the game is running it's own UI fullscreen, GUI commands are passed through here return NULL once the fullscreen UI mode should stop, or "main" to go to main menu.
Init ( ) : void

Initialize the game for the first time.
InitFromNewMap ( string mapName, idRenderWorld renderWorld, idSoundWorld soundWorld, bool isServer, bool isClient, int randSeed ) : void

Loads a map and spawns all the entities.
RunFrame ( idUserCommand userCommands ) : GameReturn

Runs a game frame, may return a session command for level changing, etc.
SelectTimeGroup ( int timeGroup ) : void

Used to manage divergent time-lines.
SetPersistentPlayerInformation ( int clientIndex, idDict playerInfo ) : void

The session calls this right before a new level is loaded.
SetServerInfo ( idDict serverInfo ) : void

Sets the serverinfo at map loads and when it changes.
SetUserInformation ( int clientIndex, idDict userInfo, bool isClient, bool canModify ) : idDict

Sets the user info for a client.
SpawnPlayer ( int clientIndex ) : void

Spawns the player entity to be used by the client.

Method Details

CacheDictionaryMedia() public abstract method

Caches media referenced from in key/value pairs in the given dictionary.
This is called after parsing an EntityDef and for each entity spawnArgs before merging the entitydef. It could be done post-merge, but that would avoid the fast pre-cache check associated with each entityDef.
public abstract CacheDictionaryMedia ( idDict dict ) : void
dict idDict
return void

Draw() public abstract method

public abstract Draw ( int clientIndex ) : bool
clientIndex int
return bool

GetMapLoadingInterface() public abstract method

public abstract GetMapLoadingInterface ( string defaultInterface ) : string
defaultInterface string
return string

GetTimeGroupTime() public abstract method

Used to manage divergent time-lines.
public abstract GetTimeGroupTime ( int timeGroup ) : int
timeGroup int
return int

HandleGuiCommands() public abstract method

When the game is running it's own UI fullscreen, GUI commands are passed through here return NULL once the fullscreen UI mode should stop, or "main" to go to main menu.
public abstract HandleGuiCommands ( string menuCommand ) : string
menuCommand string
return string

Init() public abstract method

Initialize the game for the first time.
public abstract Init ( ) : void
return void

InitFromNewMap() public abstract method

Loads a map and spawns all the entities.
public abstract InitFromNewMap ( string mapName, idRenderWorld renderWorld, idSoundWorld soundWorld, bool isServer, bool isClient, int randSeed ) : void
mapName string
renderWorld idTech4.Renderer.idRenderWorld
soundWorld idTech4.Sound.idSoundWorld
isServer bool
isClient bool
randSeed int
return void

RunFrame() public abstract method

Runs a game frame, may return a session command for level changing, etc.
public abstract RunFrame ( idUserCommand userCommands ) : GameReturn
userCommands idTech4.Input.idUserCommand
return GameReturn

SelectTimeGroup() public abstract method

Used to manage divergent time-lines.
public abstract SelectTimeGroup ( int timeGroup ) : void
timeGroup int
return void

SetPersistentPlayerInformation() public abstract method

The session calls this right before a new level is loaded.
public abstract SetPersistentPlayerInformation ( int clientIndex, idDict playerInfo ) : void
clientIndex int
playerInfo idDict
return void

SetServerInfo() public abstract method

Sets the serverinfo at map loads and when it changes.
public abstract SetServerInfo ( idDict serverInfo ) : void
serverInfo idDict
return void

SetUserInformation() public abstract method

Sets the user info for a client.
public abstract SetUserInformation ( int clientIndex, idDict userInfo, bool isClient, bool canModify ) : idDict
clientIndex int
userInfo idDict
isClient bool
canModify bool If true, the game can modify the user info. Never true on a network client.
return idDict

SpawnPlayer() public abstract method

Spawns the player entity to be used by the client.
public abstract SpawnPlayer ( int clientIndex ) : void
clientIndex int
return void