weaponInfo_t Struct Reference

About this class

Weapon library.

Public Member Functions
string	Type (string weaponDef)
	Get the "attack" type of the weapon. More...
int	StartAmmo (string weaponDef)
int	MaxAmmo (string weaponDef)
	Find the amount of ammo a weapon can hold in total when it comes to reserve ammo. More...
float	IsSemiAuto (string weaponDef)
	Find out whether the weapon is semi-automatic. More...
string	InventoryType (string weaponDef)
	Find out how this weapon is stored. More...
float	FireTime (string weaponDef)
	Find out the minimum delay between shots of a weapon, in seconds. More...
int	ClipSize (string weaponDef)
	Find out what the clip size of a weapon is. More...
string	Class (string weaponDef)
float	IsClipOnly (string weaponDef)
	Find out if a weapon takes its ammo only through its clip. More...
float	IsDetonationTimed (string weaponDef)
	Find out whether a weapon has anything to do with a timed detonation. More...

Member Function Documentation

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.

ClipSize()

int weaponInfo_t::ClipSize

(

string

weaponDef

)

Find out what the clip size of a weapon is.

Returns

integer value containing the size of the clip.

Parameters

weaponDef

the name of the entityDef that defines the weapon.

FireTime()

float weaponInfo_t::FireTime

(

string

weaponDef

)

Find out the minimum delay between shots of a weapon, in seconds.

Returns

floating point value containing the delay in seconds.

Parameters

weaponDef

the name of the entityDef that defines the weapon.

InventoryType()

string weaponInfo_t::InventoryType

(

string

weaponDef

)

Find out how this weapon is stored.

Returns

a string description of how it's stored. Usually "item", unless it's temporary.

Parameters

weaponDef

the name of the entityDef that defines the weapon.

IsClipOnly()

float weaponInfo_t::IsClipOnly

(

string

weaponDef

)

Find out if a weapon takes its ammo only through its clip.

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()

float weaponInfo_t::IsDetonationTimed

(

string

weaponDef

)

Find out whether a weapon has anything to do with a timed detonation.

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()

float weaponInfo_t::IsSemiAuto

(

string

weaponDef

)

Find out whether the weapon is semi-automatic.

If yes, you can not hold down fire, you have to press the fire key for each individual shot.

Returns

a value that when true means the weapon is semi-automatic.

Parameters

weaponDef

the name of the entityDef that defines the weapon.

MaxAmmo()

int weaponInfo_t::MaxAmmo

(

string

weaponDef

)

Find the amount of ammo a weapon can hold in total when it comes to reserve ammo.

So this is really returning the max ammo of a given ammo type.

Returns

integer value containing the max reserve ammo that weapon can have.

Parameters

weaponDef

the name of the entityDef that defines the weapon.

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.

Type()

string weaponInfo_t::Type

(

string

weaponDef

)

Get the "attack" type of the weapon.

Parameters

weaponDef

the name of the entityDef that defines the weapon.

Returns

Attack type of the weapon.

---

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

• src/shared/api.h