Shared multiprogs API. More...

Detailed Description

Shared multiprogs API.

APIs used by both client and server progs.

Classes
struct	ammoAPI_t

struct	cvarAPI_t

struct	serverinfoAPI_t

struct	userinfoAPI_t

struct	weaponInfo_t

struct	teamAPI_t

struct	entityDefAPI_t

struct	precacheAPI_t

struct	declAPI_t

Functions
string	ammoAPI_t::NameForNum (int)
	Returns the name of the specified ammo type. More...

int	ammoAPI_t::NumForName (string)
	Returns the ammo id of a given name of ammo. More...

int	ammoAPI_t::MaxForName (string)
	Returns the max ammo given name of ammo. More...

int	ammoAPI_t::MaxForNum (int)
	Returns the max ammo given name of ammo. More...

string	cvarAPI_t::GetString (string cvarName)
	Returns the string value of a console variable. More...

int	cvarAPI_t::GetInteger (string cvarName)
	Returns the integer value of a console variable. More...

float	cvarAPI_t::GetFloat (string cvarName)
	Returns the floating-point value of a console variable. More...

bool	cvarAPI_t::GetBool (string cvarName)
	Returns the boolean value of a console variable. More...

vector	cvarAPI_t::GetVector (string cvarName)
	Returns the vector value of a console variable. More...

void	cvarAPI_t::SetString (string cvarName, string setValue)
	Sets the specified console variable to a set string value. More...

void	cvarAPI_t::SetInteger (string cvarName, int setValue)
	Sets the specified console variable to a set integer value. More...

void	cvarAPI_t::SetBool (string cvarName, bool setValue)
	Sets the specified console variable to a set boolean value. More...

void	cvarAPI_t::SetFloat (string cvarName, float setValue)
	Sets the specified console variable to a set floating-point value. More...

void	cvarAPI_t::SetVector (string cvarName, vector setValue)
	Sets the specified console variable to a set vector. More...

string	serverinfoAPI_t::GetString (string serverKey)
	Returns the string value of a server info-key. More...

int	serverinfoAPI_t::GetInteger (string serverKey)
	Returns the integer value of a server info-key. More...

float	serverinfoAPI_t::GetFloat (string serverKey)
	Returns the floating-point value of a server info-key. More...

bool	serverinfoAPI_t::GetBool (string serverKey)
	Returns the boolean value of a server info-key. More...

vector	serverinfoAPI_t::GetVector (string serverKey)
	Returns the vector value of a server info-key. More...

void	serverinfoAPI_t::SetString (string serverKey, string setValue)
	Sets the specified server info-key to a set string value. More...

void	serverinfoAPI_t::SetInteger (string serverKey, int setValue)
	Sets the specified server info-key to a set integer value. More...

void	serverinfoAPI_t::SetBool (string serverKey, bool setValue)
	Sets the specified server info-key to a set boolean value. More...

void	serverinfoAPI_t::SetFloat (string serverKey, float setValue)
	Sets the specified server info-key to a set floating-point value. More...

void	serverinfoAPI_t::SetVector (string serverKey, vector setValue)
	Sets the specified server info-key to a set vector. More...

string	userinfoAPI_t::GetString (entity clientEnt, string userKey)
	Returns the string value of a user info-key. More...

int	userinfoAPI_t::GetInteger (entity clientEnt, string userKey)
	Returns the integer value of a user info-key. More...

float	userinfoAPI_t::GetFloat (entity clientEnt, string userKey)
	Returns the floating-point value of a user info-key. More...

bool	userinfoAPI_t::GetBool (entity clientEnt, string userKey)
	Returns the boolean value of a user info-key. More...

vector	userinfoAPI_t::GetVector (entity clientEnt, string userKey)
	Returns the vector value of a user info-key. More...

void	userinfoAPI_t::SetString (entity clientEnt, string userKey, string setValue)
	Sets the specified user info-key to a set string value. More...

void	userinfoAPI_t::SetInteger (entity clientEnt, string userKey, int setValue)
	Sets the specified user info-key to a set integer value. More...

void	userinfoAPI_t::SetBool (entity clientEnt, string userKey, bool setValue)
	Sets the specified user info-key to a set boolean value. More...

void	userinfoAPI_t::SetFloat (entity clientEnt, string userKey, float setValue)
	Sets the specified user info-key to a set floating-point value. More...

void	userinfoAPI_t::SetVector (entity clientEnt, string userKey, vector setValue)
	Sets the specified user info-key to a set vector. More...

string	weaponInfo_t::Type (string weaponDef)

int	weaponInfo_t::StartAmmo (string weaponDef)

int	weaponInfo_t::MaxAmmo (string weaponDef)

bool	weaponInfo_t::IsSemiAuto (string weaponDef)

string	weaponInfo_t::InventoryType (string weaponDef)

float	weaponInfo_t::FireTime (string weaponDef)

int	weaponInfo_t::ClipSize (string weaponDef)

string	weaponInfo_t::Class (string weaponDef)

bool	weaponInfo_t::IsClipOnly (string weaponDef)

bool	weaponInfo_t::IsDetonationTimed (string weaponDef)

int	teamAPI_t::BestAutoJoinTeam (void)

int	teamAPI_t::TeamCount (void)

int	teamAPI_t::OpenTeamCount (void)

vector	teamAPI_t::Color (int)

string	teamAPI_t::Name (int)

int	teamAPI_t::Score (int)

string	teamAPI_t::SpawnPoint (int)

int	teamAPI_t::NumPlayers (int)

int	teamAPI_t::NumAlivePlayers (int)

int	teamAPI_t::NumDeadPlayers (int)

int	teamAPI_t::TotalDeaths (int)

int	teamAPI_t::TotalFrags (int)

bool	teamAPI_t::Valid (int)

void	teamAPI_t::AddScore (int, int)

void	teamAPI_t::SetScore (int, int)

entity	teamAPI_t::RandomPlayer (int)

void	teamAPI_t::SetUp (int teamID, string teamTitle, vector teamColor, bool openTeam)
	Sets up a team for the current session. More...

void	teamAPI_t::AddClass (int teamID, string classType)
	Sets up a team class for the current session. More...

int	teamAPI_t::TotalClasses (int teamID)
	Returns the maximum number of classes this team can select. More...

string	teamAPI_t::ClassForIndex (int teamID, int classIndex)
	Returns the class type of a given team + index. More...

void	teamAPI_t::SetSpawnPoint (int teamID, string spawnPointEntityClassname)
	Sets up a team spawn point for the current session. More...

string	entityDefAPI_t::GetString (string defName, string keyName)
	Returns the string value of a EntityDef key. More...

int	entityDefAPI_t::GetInteger (string defName, string keyName)
	Returns the integer value of a EntityDef key. More...

float	entityDefAPI_t::GetFloat (string defName, string keyName)
	Returns the floating-point value of a EntityDef key. More...

bool	entityDefAPI_t::GetBool (string defName, string keyName)
	Returns the boolean value of a EntityDef key. More...

vector	entityDefAPI_t::GetVector (string defName, string keyName)
	Returns the vector value of a EntityDef key. More...

float	precacheAPI_t::Model (string)

float	precacheAPI_t::Sound (string)

decl	declAPI_t::New (void)
	Returns the name of a new decl in which you can store key/value pairs in. More...

string	declAPI_t::GetString (decl declHandle, string keyName)
	Returns the string value of a key from a decl. More...

int	declAPI_t::GetInteger (decl declHandle, string keyName)
	Returns the integer value of a decl key. More...

float	declAPI_t::GetFloat (decl declHandle, string keyName)
	Returns the floating-point value of a decl key. More...

bool	declAPI_t::GetBool (decl declHandle, string keyName)
	Returns the boolean value of a decl key. More...

vector	declAPI_t::GetVector (decl declHandle, string keyName)
	Returns the vector value of a decl key. More...

void	declAPI_t::AddKey (decl declHandle, string keyName, string setValue)
	Adds/updates a named key within a decl with a new string value. More...

void	declAPI_t::RemoveKey (decl declHandle, string keyName)
	Removes a named key from a decl entirely. More...

void	declAPI_t::Delete (decl declHandle)
	Removes a named decl from the game. More...

__variant	linkToSharedProgs (string funcName)

void	_shared_main (void)

Typedefs
typedef string	decl

Variables
ammoAPI_t	ammo

cvarAPI_t	cvars

serverinfoAPI_t	serverinfo

userinfoAPI_t	userinfo

weaponInfo_t	weaponInfo

teamAPI_t	teams

entityDefAPI_t	entityDef

precacheAPI_t	precache

declAPI_t	declManager

Function Documentation

◆ _shared_main()

void _shared_main ( void )

◆ AddClass()

void teamAPI_t::AddClass	(	int	teamID,
		string	classType
	)

Sets up a team class for the current session.

Making them available to choose in the team selection menu. You can have different classes per teams also.

Parameters

teamID	specifies which team slot to occupy.
classType	specifies the name of the player class. Used as an identifer in rules and menus.

◆ AddKey()

void declAPI_t::AddKey	(	decl	declHandle,
		string	keyName,
		string	setValue
	)

Adds/updates a named key within a decl with a new string value.

Parameters

declHandle	is the `decl` reference to update.
keyName	specifies the key to set.
setValue	specifies the value we'll set the key to.

◆ AddScore()

void teamAPI_t::AddScore	(	int	,
		int
	)

◆ BestAutoJoinTeam()

int teamAPI_t::BestAutoJoinTeam ( void )

◆ Class()

string weaponInfo_t::Class ( string weaponDef )

Returns: The 'class' of weapon. Not spawnclass.

Parameters

weaponDef the name of the entityDef that defines the weapon.

◆ ClassForIndex()

string teamAPI_t::ClassForIndex	(	int	teamID,
		int	classIndex
	)

Returns the class type of a given team + index.

Parameters

teamID	specifies which team slot to query for class types.
classIndex	specifies the index of the class to query. Use teams.TotalClasses() for the range.

◆ ClipSize()

int weaponInfo_t::ClipSize ( string weaponDef )

Returns: The delay (in seconds) betwen shots of the specified weapon.

Parameters

weaponDef the name of the entityDef that defines the weapon.

◆ Color()

vector teamAPI_t::Color ( int )

◆ Delete()

void declAPI_t::Delete ( decl declHandle )

Removes a named decl from the game.

Parameters

declHandle specifies the decl to delete.

◆ FireTime()

float weaponInfo_t::FireTime ( string weaponDef )

Returns: The delay (in seconds) betwen shots of the specified weapon.

Parameters

weaponDef the name of the entityDef that defines the weapon.

◆ GetBool() [1/5]

bool declAPI_t::GetBool	(	decl	declHandle,
		string	keyName
	)

Returns the boolean value of a decl key.

Parameters

declHandle	is the `decl` reference to update.
keyName	specifies the name of the key to query within the decl.

Returns: The key its value in boolean form.

◆ GetBool() [2/5]

bool userinfoAPI_t::GetBool	(	entity	clientEnt,
		string	userKey
	)

Returns the boolean value of a user info-key.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to query.

Returns: The value in boolean form.

◆ GetBool() [3/5]

bool cvarAPI_t::GetBool ( string cvarName )

Returns the boolean value of a console variable.

Parameters

cvarName specifies the console variable key to query.

Returns: The value in boolean form.

◆ GetBool() [4/5]

bool entityDefAPI_t::GetBool	(	string	defName,
		string	keyName
	)

Returns the boolean value of a EntityDef key.

Parameters

defName	specifies the EntityDef name in question
keyName	specifies the EntityDef key to query.

Returns: The value in boolean form.

◆ GetBool() [5/5]

bool serverinfoAPI_t::GetBool ( string serverKey )

Returns the boolean value of a server info-key.

Parameters

serverKey specifies the server info-key to query.

Returns: The value in boolean form.

◆ GetFloat() [1/5]

float declAPI_t::GetFloat	(	decl	declHandle,
		string	keyName
	)

Returns the floating-point value of a decl key.

Parameters

declHandle	is the `decl` reference to update.
keyName	specifies the name of the key to query within the decl.

Returns: The key its value in floating-point format.

◆ GetFloat() [2/5]

float userinfoAPI_t::GetFloat	(	entity	clientEnt,
		string	userKey
	)

Returns the floating-point value of a user info-key.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to query.

Returns: The value in floating-point format.

◆ GetFloat() [3/5]

float cvarAPI_t::GetFloat ( string cvarName )

Returns the floating-point value of a console variable.

Parameters

cvarName specifies the console variable key to query.

Returns: The value in floating-point format.

◆ GetFloat() [4/5]

float entityDefAPI_t::GetFloat	(	string	defName,
		string	keyName
	)

Returns the floating-point value of a EntityDef key.

Parameters

defName	specifies the EntityDef name in question
keyName	specifies the EntityDef key to query.

Returns: The value in floating-point format.

◆ GetFloat() [5/5]

float serverinfoAPI_t::GetFloat ( string serverKey )

Returns the floating-point value of a server info-key.

Parameters

serverKey specifies the server info-key to query.

Returns: The value in floating-point format.

◆ GetInteger() [1/5]

int declAPI_t::GetInteger	(	decl	declHandle,
		string	keyName
	)

Returns the integer value of a decl key.

Parameters

declHandle	is the `decl` reference to update.
keyName	specifies the name of the key to query within the decl.

Returns: The key its value in integer format.

◆ GetInteger() [2/5]

int userinfoAPI_t::GetInteger	(	entity	clientEnt,
		string	userKey
	)

Returns the integer value of a user info-key.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to query.

Returns: The value in integer format.

◆ GetInteger() [3/5]

int cvarAPI_t::GetInteger ( string cvarName )

Returns the integer value of a console variable.

Parameters

cvarName specifies the console variable key to query.

Returns: The value in integer format.

◆ GetInteger() [4/5]

int entityDefAPI_t::GetInteger	(	string	defName,
		string	keyName
	)

Returns the integer value of a EntityDef key.

Parameters

defName	specifies the EntityDef name in question
keyName	specifies the EntityDef key to query.

Returns: The value in integer format.

◆ GetInteger() [5/5]

int serverinfoAPI_t::GetInteger ( string serverKey )

Returns the integer value of a server info-key.

Parameters

serverKey specifies the server info-key to query.

Returns: The value in integer format.

◆ GetString() [1/5]

string declAPI_t::GetString	(	decl	declHandle,
		string	keyName
	)

Returns the string value of a key from a decl.

Parameters

declHandle	is the `decl` reference to update.
keyName	specifies the name of the key to query within the decl.

Returns: The key its value in string format.

◆ GetString() [2/5]

string userinfoAPI_t::GetString	(	entity	clientEnt,
		string	userKey
	)

Returns the string value of a user info-key.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to query.

Returns: The value in string format.

◆ GetString() [3/5]

string cvarAPI_t::GetString ( string cvarName )

Returns the string value of a console variable.

Parameters

cvarName specifies the console variable key to query.

Returns: The value in string format.

◆ GetString() [4/5]

string entityDefAPI_t::GetString	(	string	defName,
		string	keyName
	)

Returns the string value of a EntityDef key.

Parameters

defName	specifies the EntityDef name in question
keyName	specifies the EntityDef key to query.

Returns: The value in string format.

◆ GetString() [5/5]

string serverinfoAPI_t::GetString ( string serverKey )

Returns the string value of a server info-key.

Parameters

serverKey specifies the server info-key to query.

Returns: The value in string format.

◆ GetVector() [1/5]

vector declAPI_t::GetVector	(	decl	declHandle,
		string	keyName
	)

Returns the vector value of a decl key.

Parameters

declHandle	is the `decl` reference to update.
keyName	specifies the name of the key to query within the decl.

Returns: The key its value in vector form.

◆ GetVector() [2/5]

vector userinfoAPI_t::GetVector	(	entity	clientEnt,
		string	userKey
	)

Returns the vector value of a user info-key.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to query.

Returns: The value in vector form.

◆ GetVector() [3/5]

vector cvarAPI_t::GetVector ( string cvarName )

Returns the vector value of a console variable.

Parameters

cvarName specifies the console variable key to query.

Returns: The value in vector form.

◆ GetVector() [4/5]

vector entityDefAPI_t::GetVector	(	string	defName,
		string	keyName
	)

Returns the vector value of a EntityDef key.

Parameters

defName	specifies the EntityDef name in question
keyName	specifies the EntityDef key to query.

Returns: The value in vector form.

◆ GetVector() [5/5]

vector serverinfoAPI_t::GetVector ( string serverKey )

Returns the vector value of a server info-key.

Parameters

serverKey specifies the server info-key to query.

Returns: The value in vector form.

◆ InventoryType()

string weaponInfo_t::InventoryType ( string weaponDef )

Returns: How this weapon is stored. Usually "item", unless it's temporary.

Parameters

weaponDef the name of the entityDef that defines the weapon.

◆ IsClipOnly()

bool weaponInfo_t::IsClipOnly ( string weaponDef )

Returns: true/false whether the weapon takes its ammo only through its clip.

Parameters

weaponDef the name of the entityDef that defines the weapon.

◆ IsDetonationTimed()

bool weaponInfo_t::IsDetonationTimed ( string weaponDef )

Returns: true/false whether or not the weapon creates a timed, fused detonating charge of sorts.

Parameters

weaponDef the name of the entityDef that defines the weapon.

◆ IsSemiAuto()

bool weaponInfo_t::IsSemiAuto ( string weaponDef )

Returns: Whether the weapon is semi automatic.

Parameters

weaponDef the name of the entityDef that defines the weapon.

◆ linkToSharedProgs()

__variant linkToSharedProgs ( string funcName )

◆ MaxAmmo()

int weaponInfo_t::MaxAmmo ( string weaponDef )

Returns: The amount of ammo the weapon can hold in total when it comes to reserve ammo. So this is really returning the max ammo of a given ammo type.

Parameters

weaponDef the name of the entityDef that defines the weapon.

◆ MaxForName()

int ammoAPI_t::MaxForName ( string )

Returns the max ammo given name of ammo.

Returns 0 when invalid.

◆ MaxForNum()

int ammoAPI_t::MaxForNum ( int )

Returns the max ammo given name of ammo.

Returns 0 when invalid.

◆ Model()

float precacheAPI_t::Model ( string )

◆ Name()

string teamAPI_t::Name ( int )

◆ NameForNum()

string ammoAPI_t::NameForNum ( int )

Returns the name of the specified ammo type.

Returns NULL when invalid.

◆ New()

decl declAPI_t::New ( void )

Returns the name of a new decl in which you can store key/value pairs in.

◆ NumAlivePlayers()

int teamAPI_t::NumAlivePlayers ( int )

◆ NumDeadPlayers()

int teamAPI_t::NumDeadPlayers ( int )

◆ NumForName()

int ammoAPI_t::NumForName ( string )

Returns the ammo id of a given name of ammo.

Return -1 when invalid.

◆ NumPlayers()

int teamAPI_t::NumPlayers ( int )

◆ OpenTeamCount()

int teamAPI_t::OpenTeamCount ( void )

◆ RandomPlayer()

entity teamAPI_t::RandomPlayer ( int )

◆ RemoveKey()

void declAPI_t::RemoveKey	(	decl	declHandle,
		string	keyName
	)

Removes a named key from a decl entirely.

Parameters

declHandle	is the `decl` reference to update.
keyName	specifies the key to remove.

◆ Score()

int teamAPI_t::Score ( int )

◆ SetBool() [1/3]

void userinfoAPI_t::SetBool	(	entity	clientEnt,
		string	userKey,
		bool	setValue
	)

Sets the specified user info-key to a set boolean value.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to set.
setValue	specifies the value of said key.

◆ SetBool() [2/3]

void cvarAPI_t::SetBool	(	string	cvarName,
		bool	setValue
	)

Sets the specified console variable to a set boolean value.

Parameters

cvarName	specifies the console variable to set.
setValue	specifies the value of said key.

◆ SetBool() [3/3]

void serverinfoAPI_t::SetBool	(	string	serverKey,
		bool	setValue
	)

Sets the specified server info-key to a set boolean value.

Parameters

serverKey	specifies the server info-key to set.
setValue	specifies the value of said key.

◆ SetFloat() [1/3]

void userinfoAPI_t::SetFloat	(	entity	clientEnt,
		string	userKey,
		float	setValue
	)

Sets the specified user info-key to a set floating-point value.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to set.
setValue	specifies the value of said key.

◆ SetFloat() [2/3]

void cvarAPI_t::SetFloat	(	string	cvarName,
		float	setValue
	)

Sets the specified console variable to a set floating-point value.

Parameters

cvarName	specifies the console variable to set.
setValue	specifies the value of said key.

◆ SetFloat() [3/3]

void serverinfoAPI_t::SetFloat	(	string	serverKey,
		float	setValue
	)

Sets the specified server info-key to a set floating-point value.

Parameters

serverKey	specifies the server info-key to set.
setValue	specifies the value of said key.

◆ SetInteger() [1/3]

void userinfoAPI_t::SetInteger	(	entity	clientEnt,
		string	userKey,
		int	setValue
	)

Sets the specified user info-key to a set integer value.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to set.
setValue	specifies the value of said key.

◆ SetInteger() [2/3]

void cvarAPI_t::SetInteger	(	string	cvarName,
		int	setValue
	)

Sets the specified console variable to a set integer value.

Parameters

cvarName	specifies the console variable to set.
setValue	specifies the value of said key.

◆ SetInteger() [3/3]

void serverinfoAPI_t::SetInteger	(	string	serverKey,
		int	setValue
	)

Sets the specified server info-key to a set integer value.

Parameters

serverKey	specifies the server info-key to set.
setValue	specifies the value of said key.

◆ SetScore()

void teamAPI_t::SetScore	(	int	,
		int
	)

◆ SetSpawnPoint()

void teamAPI_t::SetSpawnPoint	(	int	teamID,
		string	spawnPointEntityClassname
	)

Sets up a team spawn point for the current session.

Using this function you can override the default team spawn, such as info_player_deathmatch type entities - and reroute spawns for a specific team to a different class.

Parameters

teamID	specifies which team slot to occupy.
spawnPointEntityClassname	specifies the classname of this team's spawn point.

◆ SetString() [1/3]

void userinfoAPI_t::SetString	(	entity	clientEnt,
		string	userKey,
		string	setValue
	)

Sets the specified user info-key to a set string value.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to set.
setValue	specifies the value of said key.

◆ SetString() [2/3]

void cvarAPI_t::SetString	(	string	cvarName,
		string	setValue
	)

Sets the specified console variable to a set string value.

Parameters

cvarName	specifies the console variable to set.
setValue	specifies the value of said key.

◆ SetString() [3/3]

void serverinfoAPI_t::SetString	(	string	serverKey,
		string	setValue
	)

Sets the specified server info-key to a set string value.

Parameters

serverKey	specifies the server info-key to set.
setValue	specifies the value of said key.

◆ SetUp()

void teamAPI_t::SetUp	(	int	teamID,
		string	teamTitle,
		vector	teamColor,
		bool	openTeam
	)

Sets up a team for the current session.

Will flush the team specific scores.

Parameters

teamID	specifies which team slot to occupy.
teamTitle	specifies the title of the team.
teamColor	specifies the color of the team (e.g. [0, 255, 0] for green).
openTeam	specifies whether players can join the team manually.

◆ SetVector() [1/3]

void userinfoAPI_t::SetVector	(	entity	clientEnt,
		string	userKey,
		vector	setValue
	)

Sets the specified user info-key to a set vector.

Parameters

clientEnt	specifies which user to query.
userKey	specifies the user info-key to set.
setValue	specifies the value of said key.

◆ SetVector() [2/3]

void cvarAPI_t::SetVector	(	string	cvarName,
		vector	setValue
	)

Sets the specified console variable to a set vector.

Parameters

cvarName	specifies the console variable to set.
setValue	specifies the value of said key.

◆ SetVector() [3/3]

void serverinfoAPI_t::SetVector	(	string	serverKey,
		vector	setValue
	)

Sets the specified server info-key to a set vector.

Parameters

serverKey	specifies the server info-key to set.
setValue	specifies the value of said key.

◆ Sound()

float precacheAPI_t::Sound ( string )

◆ SpawnPoint()

string teamAPI_t::SpawnPoint ( int )

◆ StartAmmo()

int weaponInfo_t::StartAmmo ( string weaponDef )

Returns: The amount of ammo the specified weapon is meant to start with, when first given to the player. This can be distributed to both clip and reserve ammo types.

Parameters

weaponDef the name of the entityDef that defines the weapon.

◆ TeamCount()

int teamAPI_t::TeamCount ( void )

◆ TotalClasses()

int teamAPI_t::TotalClasses ( int teamID )

Returns the maximum number of classes this team can select.

Parameters

teamID specifies which team slot to query for class types.

◆ TotalDeaths()

int teamAPI_t::TotalDeaths ( int )

◆ TotalFrags()

int teamAPI_t::TotalFrags ( int )

◆ Type()

string weaponInfo_t::Type ( string weaponDef )

Returns: the "attack" type of the weapon.

Parameters

weaponDef the name of the entityDef that defines the weapon.

Returns: Attack type of the weapon.

◆ Valid()

bool teamAPI_t::Valid ( int )

Typedef Documentation

◆ decl

typedef string decl

Variable Documentation

◆ ammo

ammoAPI_t ammo

◆ cvars

cvarAPI_t cvars

◆ declManager

declAPI_t declManager

◆ entityDef

entityDefAPI_t entityDef

◆ precache

precacheAPI_t precache

◆ serverinfo

serverinfoAPI_t serverinfo

◆ teams

teamAPI_t teams

◆ userinfo

userinfoAPI_t userinfo

◆ weaponInfo

weaponInfo_t weaponInfo

Detailed Description

Classes

Functions

Typedefs

Variables

Function Documentation

◆ _shared_main()

◆ AddClass()

◆ AddKey()

◆ AddScore()

◆ BestAutoJoinTeam()

◆ Class()

◆ ClassForIndex()

◆ ClipSize()

◆ Color()

◆ Delete()

◆ FireTime()

◆ GetBool() [1/5]

◆ GetBool() [2/5]

◆ GetBool() [3/5]

◆ GetBool() [4/5]

◆ GetBool() [5/5]

◆ GetFloat() [1/5]

◆ GetFloat() [2/5]

◆ GetFloat() [3/5]

◆ GetFloat() [4/5]

◆ GetFloat() [5/5]

◆ GetInteger() [1/5]

◆ GetInteger() [2/5]

◆ GetInteger() [3/5]

◆ GetInteger() [4/5]

◆ GetInteger() [5/5]

◆ GetString() [1/5]

◆ GetString() [2/5]

◆ GetString() [3/5]

◆ GetString() [4/5]

◆ GetString() [5/5]

◆ GetVector() [1/5]

◆ GetVector() [2/5]

◆ GetVector() [3/5]

◆ GetVector() [4/5]

◆ GetVector() [5/5]

◆ InventoryType()

◆ IsClipOnly()

◆ IsDetonationTimed()

◆ IsSemiAuto()

◆ linkToSharedProgs()

◆ MaxAmmo()

◆ MaxForName()

◆ MaxForNum()

◆ Model()

◆ Name()

◆ NameForNum()

◆ New()

◆ NumAlivePlayers()

◆ NumDeadPlayers()

◆ NumForName()

◆ NumPlayers()

◆ OpenTeamCount()

◆ RandomPlayer()

◆ RemoveKey()

◆ Score()

◆ SetBool() [1/3]

◆ SetBool() [2/3]

◆ SetBool() [3/3]

◆ SetFloat() [1/3]

◆ SetFloat() [2/3]

◆ SetFloat() [3/3]

◆ SetInteger() [1/3]

◆ SetInteger() [2/3]

◆ SetInteger() [3/3]

◆ SetScore()

◆ SetSpawnPoint()

◆ SetString() [1/3]

◆ SetString() [2/3]

◆ SetString() [3/3]

◆ SetUp()

◆ SetVector() [1/3]

◆ SetVector() [2/3]

◆ SetVector() [3/3]