Utilities

Shared Utility API Reference. More...

Detailed Description

Shared Utility API Reference.

Functions
void	Util_ChangeClass (entity, string)
	Changes the class of a given entity. More...
string	Util_ExtensionFromString (string)
	Extract the file extension from a given file name string. More...
string	Util_ChatFormat (float, float, string)
	Format a chat message for a given player num, with a specific team set. More...
int	Util_GetMaxPlayers (void)
string	Util_GetTime (void)
float	Util_GetTimeLeft (void)
string	Util_GetAddress (void)

Variables
var int	g_numplayerslots

Function Documentation

Util_ChangeClass()

void Util_ChangeClass	(	entity	objectID,
		string	className
	)

Changes the class of a given entity.

Parameters

objectID	Target entity.
className	Name of the class the target entity will be changed to.

Util_ChatFormat()

string Util_ChatFormat	(	float	playerNum,
		float	teamNum,
		string	chatMessage
	)

Format a chat message for a given player num, with a specific team set.

Parameters

playerNum	ID of the player whose name will be displayed.
teamNum	ID of the team the message should be displayed as being from.
chatMessage	String containing the chat message to be displayed.

Returns

A colorized string with name, message and team identifier.

Util_ExtensionFromString()

string Util_ExtensionFromString

(

string

)

Extract the file extension from a given file name string.

Parameters

inputString

Path to a file. Can be local or remote.

Returns

The file extension, from the full path of a file.

Util_GetAddress()

string Util_GetAddress

(

void

)

Util_GetMaxPlayers()

int Util_GetMaxPlayers

(

void

)

Util_GetTime()

string Util_GetTime

(

void

)

Util_GetTimeLeft()

float Util_GetTimeLeft

(

void

)

Variable Documentation

g_numplayerslots

var int g_numplayerslots