api.qc File Reference

Functions
string	SHPF_cvars_GetString (string cvarName)
float	SHPF_cvars_GetFloat (string cvarName)
int	SHPF_cvars_GetInteger (string cvarName)
bool	SHPF_cvars_GetBool (string cvarName)
vector	SHPF_cvars_GetVector (string cvarName)
void	SHPF_cvars_SetString (string cvarName, string setValue)
void	SHPF_cvars_SetInteger (string cvarName, int setValue)
void	SHPF_cvars_SetBool (string cvarName, bool setValue)
void	SHPF_cvars_SetFloat (string cvarName, float setValue)
void	SHPF_cvars_SetVector (string cvarName, vector setValue)
string	SHPF_declManager_New (void)
string	SHPF_declManager_GetString (string defName, string keyName)
int	SHPF_declManager_GetInteger (string defName, string keyName)
float	SHPF_declManager_GetFloat (string defName, string keyName)
bool	SHPF_declManager_GetBool (string defName, string keyName)
vector	SHPF_declManager_GetVector (string defName, string keyName)
void	SHPF_declManager_AddKey (string defName, string keyName, string setValue)
void	SHPF_declManager_RemoveKey (string defName, string keyName)
void	SHPF_declManager_Delete (string defName, string keyName)
string	SHPF_ammo_NameForNum (int ammoIndex)
int	SHPF_ammo_NumForName (string ammoName)
int	SHPF_ammo_MaxForName (string ammoName)
int	SHPF_ammo_MaxForNum (int ammoIndex)
string	SHPF_userinfo_GetString (entity client, string keyName)
int	SHPF_userinfo_GetInteger (entity client, string keyName)
float	SHPF_userinfo_GetFloat (entity client, string keyName)
bool	SHPF_userinfo_GetBool (entity client, string keyName)
vector	SHPF_userinfo_GetVector (entity client, string keyName)
void	SHPF_userinfo_SetString (entity client, string keyName, string setValue)
void	SHPF_userinfo_SetInteger (entity client, string keyName, int setValue)
void	SHPF_userinfo_SetFloat (entity client, string keyName, float setValue)
void	SHPF_userinfo_SetBool (entity client, string keyName, bool setValue)
void	SHPF_userinfo_SetVector (entity client, string keyName, vector setValue)
string	SHPF_serverinfo_GetString (string serverKey)
float	SHPF_serverinfo_GetFloat (string serverKey)
int	SHPF_serverinfo_GetInteger (string serverKey)
bool	SHPF_serverinfo_GetBool (string serverKey)
vector	SHPF_serverinfo_GetVector (string serverKey)
void	SHPF_serverinfo_SetString (string serverKey, string setValue)
void	SHPF_serverinfo_SetInteger (string serverKey, int setValue)
void	SHPF_serverinfo_SetBool (string serverKey, bool setValue)
void	SHPF_serverinfo_SetFloat (string serverKey, float setValue)
void	SHPF_serverinfo_SetVector (string serverKey, vector setValue)
int	SHPF_teams_TeamCount (void)
vector	SHPF_teams_Color (int teamID)
string	SHPF_teams_Name (int teamID)
int	SHPF_teams_Score (int teamID)
string	SHPF_teams_SpawnPoint (int teamID)
int	SHPF_teams_NumPlayers (int teamID)
int	SHPF_teams_NumAlivePlayers (int teamID)
entity	SHPF_teams_RandomPlayer (int teamID)
int	SHPF_teams_NumDeadPlayers (int teamID)
int	SHPF_teams_TotalDeaths (int teamID)
int	SHPF_teams_TotalFrags (int teamID)
bool	SHPF_teams_Valid (int teamID)
int	SHPF_teams_BestAutoJoinTeam (void)
void	SHPF_teams_SetScore (int teamID, int setValue)
void	SHPF_teams_AddScore (int teamID, int addValue)
void	SHPF_teams_SetUp (int teamID, string teamTitle, vector teamColor, bool openTeam)
void	SHPF_teams_SetSpawnPoint (int teamID, string spawnPoint)
string	SHPF_weaponInfo_Type (string weaponDef)
int	SHPF_weaponInfo_StartAmmo (string weaponDef)
int	SHPF_weaponInfo_MaxAmmo (string weaponDef)
bool	SHPF_weaponInfo_IsSemiAuto (string weaponDef)
string	SHPF_weaponInfo_InventoryType (string weaponDef)
float	SHPF_weaponInfo_FireTime (string weaponDef)
int	SHPF_weaponInfo_ClipSize (string weaponDef)
string	SHPF_weaponInfo_Class (string weaponDef)
bool	SHPF_weaponInfo_IsClipOnly (string weaponDef)
bool	SHPF_weaponInfo_IsDetonationTimed (string weaponDef)
NSEntity	spawnClass (string className, vector desiredPos)
	Returns a new entity. More...
bool	changeClass (entity target, string className)
void	sendInput (entity target, string inputName, string dataString, entity activator)
bool	isAI (entity entityToCheck)
bool	isAlive (entity entityToCheck)
bool	isGodMode (entity entityToCheck)
bool	isClient (entity entityToCheck)
bool	isPlayer (entity entityToCheck)
bool	isSentient (entity entityToCheck)
bool	isBot (entity entityToCheck)
bool	isWeapon (entity entityToCheck)
bool	isItem (entity entityToCheck)
string	SHPF_entityDef_GetString (string declName, string keyName)
int	SHPF_entityDef_GetInteger (string declName, string keyName)
bool	SHPF_entityDef_GetBool (string declName, string keyName)
float	SHPF_entityDef_GetFloat (string declName, string keyName)
vector	SHPF_entityDef_GetVector (string declName, string keyName)

Function Documentation

changeClass()

bool changeClass	(	entity	target,
		string	className
	)

isAI()

bool isAI

(

entity

entityToCheck

)

isAlive()

bool isAlive

(

entity

entityToCheck

)

isBot()

bool isBot

(

entity

entityToCheck

)

isClient()

bool isClient

(

entity

entityToCheck

)

isGodMode()

bool isGodMode

(

entity

entityToCheck

)

isItem()

bool isItem

(

entity

entityToCheck

)

isPlayer()

bool isPlayer

(

entity

entityToCheck

)

isSentient()

bool isSentient

(

entity

entityToCheck

)

isWeapon()

bool isWeapon

(

entity

entityToCheck

)

sendInput()

void sendInput	(	entity	target,
		string	inputName,
		string	dataString,
		entity	activator
	)

SHPF_ammo_MaxForName()

int SHPF_ammo_MaxForName

(

string

ammoName

)

SHPF_ammo_MaxForNum()

int SHPF_ammo_MaxForNum

(

int

ammoIndex

)

SHPF_ammo_NameForNum()

string SHPF_ammo_NameForNum

(

int

ammoIndex

)

SHPF_ammo_NumForName()

int SHPF_ammo_NumForName

(

string

ammoName

)

SHPF_cvars_GetBool()

bool SHPF_cvars_GetBool

(

string

cvarName

)

SHPF_cvars_GetFloat()

float SHPF_cvars_GetFloat

(

string

cvarName

)

SHPF_cvars_GetInteger()

int SHPF_cvars_GetInteger

(

string

cvarName

)

SHPF_cvars_GetString()

string SHPF_cvars_GetString

(

string

cvarName

)

SHPF_cvars_GetVector()

vector SHPF_cvars_GetVector

(

string

cvarName

)

SHPF_cvars_SetBool()

void SHPF_cvars_SetBool	(	string	cvarName,
		bool	setValue
	)

SHPF_cvars_SetFloat()

void SHPF_cvars_SetFloat	(	string	cvarName,
		float	setValue
	)

SHPF_cvars_SetInteger()

void SHPF_cvars_SetInteger	(	string	cvarName,
		int	setValue
	)

SHPF_cvars_SetString()

void SHPF_cvars_SetString	(	string	cvarName,
		string	setValue
	)

SHPF_cvars_SetVector()

void SHPF_cvars_SetVector	(	string	cvarName,
		vector	setValue
	)

SHPF_declManager_AddKey()

void SHPF_declManager_AddKey	(	string	defName,
		string	keyName,
		string	setValue
	)

SHPF_declManager_Delete()

void SHPF_declManager_Delete	(	string	defName,
		string	keyName
	)

SHPF_declManager_GetBool()

bool SHPF_declManager_GetBool	(	string	defName,
		string	keyName
	)

SHPF_declManager_GetFloat()

float SHPF_declManager_GetFloat	(	string	defName,
		string	keyName
	)

SHPF_declManager_GetInteger()

int SHPF_declManager_GetInteger	(	string	defName,
		string	keyName
	)

SHPF_declManager_GetString()

string SHPF_declManager_GetString	(	string	defName,
		string	keyName
	)

SHPF_declManager_GetVector()

vector SHPF_declManager_GetVector	(	string	defName,
		string	keyName
	)

SHPF_declManager_New()

string SHPF_declManager_New

(

void

)

SHPF_declManager_RemoveKey()

void SHPF_declManager_RemoveKey	(	string	defName,
		string	keyName
	)

SHPF_entityDef_GetBool()

bool SHPF_entityDef_GetBool	(	string	declName,
		string	keyName
	)

SHPF_entityDef_GetFloat()

float SHPF_entityDef_GetFloat	(	string	declName,
		string	keyName
	)

SHPF_entityDef_GetInteger()

int SHPF_entityDef_GetInteger	(	string	declName,
		string	keyName
	)

SHPF_entityDef_GetString()

string SHPF_entityDef_GetString	(	string	declName,
		string	keyName
	)

SHPF_entityDef_GetVector()

vector SHPF_entityDef_GetVector	(	string	declName,
		string	keyName
	)

SHPF_serverinfo_GetBool()

bool SHPF_serverinfo_GetBool

(

string

serverKey

)

SHPF_serverinfo_GetFloat()

float SHPF_serverinfo_GetFloat

(

string

serverKey

)

SHPF_serverinfo_GetInteger()

int SHPF_serverinfo_GetInteger

(

string

serverKey

)

SHPF_serverinfo_GetString()

string SHPF_serverinfo_GetString

(

string

serverKey

)

SHPF_serverinfo_GetVector()

vector SHPF_serverinfo_GetVector

(

string

serverKey

)

SHPF_serverinfo_SetBool()

void SHPF_serverinfo_SetBool	(	string	serverKey,
		bool	setValue
	)

SHPF_serverinfo_SetFloat()

void SHPF_serverinfo_SetFloat	(	string	serverKey,
		float	setValue
	)

SHPF_serverinfo_SetInteger()

void SHPF_serverinfo_SetInteger	(	string	serverKey,
		int	setValue
	)

SHPF_serverinfo_SetString()

void SHPF_serverinfo_SetString	(	string	serverKey,
		string	setValue
	)

SHPF_serverinfo_SetVector()

void SHPF_serverinfo_SetVector	(	string	serverKey,
		vector	setValue
	)

SHPF_teams_AddScore()

void SHPF_teams_AddScore	(	int	teamID,
		int	addValue
	)

SHPF_teams_BestAutoJoinTeam()

int SHPF_teams_BestAutoJoinTeam

(

void

)

SHPF_teams_Color()

vector SHPF_teams_Color

(

int

teamID

)

SHPF_teams_Name()

string SHPF_teams_Name

(

int

teamID

)

SHPF_teams_NumAlivePlayers()

int SHPF_teams_NumAlivePlayers

(

int

teamID

)

SHPF_teams_NumDeadPlayers()

int SHPF_teams_NumDeadPlayers

(

int

teamID

)

SHPF_teams_NumPlayers()

int SHPF_teams_NumPlayers

(

int

teamID

)

SHPF_teams_RandomPlayer()

entity SHPF_teams_RandomPlayer

(

int

teamID

)

SHPF_teams_Score()

int SHPF_teams_Score

(

int

teamID

)

SHPF_teams_SetScore()

void SHPF_teams_SetScore	(	int	teamID,
		int	setValue
	)

SHPF_teams_SetSpawnPoint()

void SHPF_teams_SetSpawnPoint	(	int	teamID,
		string	spawnPoint
	)

SHPF_teams_SetUp()

void SHPF_teams_SetUp	(	int	teamID,
		string	teamTitle,
		vector	teamColor,
		bool	openTeam
	)

SHPF_teams_SpawnPoint()

string SHPF_teams_SpawnPoint

(

int

teamID

)

SHPF_teams_TeamCount()

int SHPF_teams_TeamCount

(

void

)

SHPF_teams_TotalDeaths()

int SHPF_teams_TotalDeaths

(

int

teamID

)

SHPF_teams_TotalFrags()

int SHPF_teams_TotalFrags

(

int

teamID

)

SHPF_teams_Valid()

bool SHPF_teams_Valid

(

int

teamID

)

SHPF_userinfo_GetBool()

bool SHPF_userinfo_GetBool	(	entity	client,
		string	keyName
	)

SHPF_userinfo_GetFloat()

float SHPF_userinfo_GetFloat	(	entity	client,
		string	keyName
	)

SHPF_userinfo_GetInteger()

int SHPF_userinfo_GetInteger	(	entity	client,
		string	keyName
	)

SHPF_userinfo_GetString()

string SHPF_userinfo_GetString	(	entity	client,
		string	keyName
	)

SHPF_userinfo_GetVector()

vector SHPF_userinfo_GetVector	(	entity	client,
		string	keyName
	)

SHPF_userinfo_SetBool()

void SHPF_userinfo_SetBool	(	entity	client,
		string	keyName,
		bool	setValue
	)

SHPF_userinfo_SetFloat()

void SHPF_userinfo_SetFloat	(	entity	client,
		string	keyName,
		float	setValue
	)

SHPF_userinfo_SetInteger()

void SHPF_userinfo_SetInteger	(	entity	client,
		string	keyName,
		int	setValue
	)

SHPF_userinfo_SetString()

void SHPF_userinfo_SetString	(	entity	client,
		string	keyName,
		string	setValue
	)

SHPF_userinfo_SetVector()

void SHPF_userinfo_SetVector	(	entity	client,
		string	keyName,
		vector	setValue
	)

SHPF_weaponInfo_Class()

string SHPF_weaponInfo_Class

(

string

weaponDef

)

SHPF_weaponInfo_ClipSize()

int SHPF_weaponInfo_ClipSize

(

string

weaponDef

)

SHPF_weaponInfo_FireTime()

float SHPF_weaponInfo_FireTime

(

string

weaponDef

)

SHPF_weaponInfo_InventoryType()

string SHPF_weaponInfo_InventoryType

(

string

weaponDef

)

SHPF_weaponInfo_IsClipOnly()

bool SHPF_weaponInfo_IsClipOnly

(

string

weaponDef

)

SHPF_weaponInfo_IsDetonationTimed()

bool SHPF_weaponInfo_IsDetonationTimed

(

string

weaponDef

)

SHPF_weaponInfo_IsSemiAuto()

bool SHPF_weaponInfo_IsSemiAuto

(

string

weaponDef

)

SHPF_weaponInfo_MaxAmmo()

int SHPF_weaponInfo_MaxAmmo

(

string

weaponDef

)

SHPF_weaponInfo_StartAmmo()

int SHPF_weaponInfo_StartAmmo

(

string

weaponDef

)

SHPF_weaponInfo_Type()

string SHPF_weaponInfo_Type

(

string

weaponDef

)

spawnClass()

NSEntity spawnClass	(	string	className,
		vector	desiredPos
	)

Returns a new entity.

Guaranteed to be something. Never NULL unless we're seriously out of memory.