gameAPI_t Struct Reference

About this class

Game library.

Public Member Functions
void	EndMap (void)
	Ends the current map.
void	EndMapDelayed (float)
	Ends the current map in the specified number of seconds.
void	LoadNextMap (void)
	Force loads the next map/level in the rotation.
void	CleanUpMap (void)
	Removed any temporary game entities from the game, and resets the state of the level to the default state.
string	GetMap (void)
	Returns the name of the map/level.
string	GetNextMap (void)
	Returns the name of the next map/level in the rotation.
void	SetSpawnPoint (string spawnPointClass)
	Sets the default spawn-point class to custom one.
void	TeleportToSpawn (entity teleportingEntity)
	Teleports an entity to their ideal spawn-point.
entity	FindRandomClassObject (string entityClassName)
	Return a random instance of a specified entity class.

Member Function Documentation

CleanUpMap()

void gameAPI_t::CleanUpMap

(

void

)

Removed any temporary game entities from the game, and resets the state of the level to the default state.

EndMap()

void gameAPI_t::EndMap

(

void

)

Ends the current map.

Resulting in the scores and intermission screens being shown.

EndMapDelayed()

void gameAPI_t::EndMapDelayed

(

float

)

Ends the current map in the specified number of seconds.

FindRandomClassObject()

entity gameAPI_t::FindRandomClassObject

(

string

entityClassName

)

Return a random instance of a specified entity class.

Parameters

entityClassName

is the desired entity class name, such as "info_player_deathmatch".

Returns

a valid entity result, or __NULL__ when not existant in the map/level.

GetMap()

string gameAPI_t::GetMap

(

void

)

Returns the name of the map/level.

Returns

the name of the map/level, such as "tw_grime"

GetNextMap()

string gameAPI_t::GetNextMap

(

void

)

Returns the name of the next map/level in the rotation.

Returns

the name of the map/level, such as "tw_dune"

LoadNextMap()

void gameAPI_t::LoadNextMap

(

void

)

Force loads the next map/level in the rotation.

If none is set, the map will restart.

SetSpawnPoint()

void gameAPI_t::SetSpawnPoint

(

string

spawnPointClass

)

Sets the default spawn-point class to custom one.

Does not affect members of teams, which have their own API.

Parameters

spawnPointClass

is the name of the spawn-point class, such as "info_player_start".

TeleportToSpawn()

void gameAPI_t::TeleportToSpawn

(

entity

teleportingEntity

)

Teleports an entity to their ideal spawn-point.

Parameters

teleportingEntity

is the entity to teleport.

---

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

• src/server/api_func.h