Header file that describes the functions related to game items. More...

This graph shows which files directly or indirectly include this file:

Macros
#define	ITEM_IS_EXPIRING(item)
	Returns whether the item is expiring (i.e.
#define	ITEM_IS_LOOT(item)
	Returns whether the item is loot.
#define	ITEM_SET_EXPIRING(item, expiring)
	Sets the item expiring status (i.e.
#define	ITEM_SET_LOOT(item, loot)
	Sets the item loot status.
#define	ITEM_SHOULD_KEEP_POSITION(item)
	Returns whether item should keep its position or be dropped to the ground.

Functions
bool	Item_Initialise (entity item)
	An optimised and generic way to initialise items (loot or permanent)
bool	Item_IsDefinitionAllowed (entity definition)
	Checks whether the items with the specified definition are allowed to spawn.
entity	Item_RandomFromList (string itemlist)
	Takes a space-separated list of netnames, returns the itemdef of one of them (or NULL if none are available).

Variables
float	lifetime
	lifetime < 0 means permanent (not loot), lifetime > 0 overrides the default
bool	m_isexpiring
	Holds whether strength, shield or superweapon timers expire while this item is on the ground.
bool	m_isloot
	Holds whether item is loot.
bool	startitem_failed

Detailed Description

Header file that describes the functions related to game items.

Copyright: GNU GPLv2 or any later version.

Definition in file spawning.qh.

Macro Definition Documentation

◆ ITEM_IS_EXPIRING

#define ITEM_IS_EXPIRING ( item )

Value:

(item.m_isexpiring)

Returns whether the item is expiring (i.e.

its strength, shield and superweapon timers expire while it is on the ground).

Parameters

[in] item Item to check.

Returns: True if the item is expiring, false otherwise.

Definition at line 58 of file spawning.qh.

Referenced by Item_Touch(), and StartItem().

◆ ITEM_IS_LOOT

#define ITEM_IS_LOOT ( item )

Value:

(item.m_isloot || item.classname == "droppedweapon")

Returns whether the item is loot.

Parameters

[in] item Item to check.

Returns: True if the item is loot, false otherwise.

Definition at line 39 of file spawning.qh.

Referenced by havocbot_goalrating_items(), havocbot_movetogoal(), isPushable(), Item_Reset(), Item_Think(), Item_Touch(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), MUTATOR_HOOKFUNCTION(), setItemGroup(), StartItem(), target_items_use(), and weapon_defaultspawnfunc().

◆ ITEM_SET_EXPIRING

#define ITEM_SET_EXPIRING	(		item,
			expiring )

Value:

(item.m_isexpiring = expiring)

Sets the item expiring status (i.e.

whether its strength, shield and superweapon timers expire while it is on the ground).

Parameters

[in,out]	item	Item to adjust.
[in]	expiring	Whether item is expiring.

Returns: No return.

Definition at line 65 of file spawning.qh.

Referenced by powerups_DropItem(), and W_ThrowNewWeapon().

◆ ITEM_SET_LOOT

#define ITEM_SET_LOOT	(		item,
			loot )

Value:

(item.m_isloot = loot)

Sets the item loot status.

Parameters

[in,out]	item	Item to adjust.
[in]	loot	Whether item is loot.

Returns: No return.

Definition at line 45 of file spawning.qh.

Referenced by Item_Initialise(), monster_dropitem(), and W_ThrowNewWeapon().

◆ ITEM_SHOULD_KEEP_POSITION

#define ITEM_SHOULD_KEEP_POSITION ( item )

Value:

(item.noalign || (item.spawnflags & 1))

Returns whether item should keep its position or be dropped to the ground.

Parameters

[in] item Item to check.

Returns: True if item should keep its position or false if it should be dropped to the ground.

Definition at line 52 of file spawning.qh.

Referenced by buff_SpawnReplacement(), and Item_CopyFields().

Function Documentation

◆ Item_Initialise()

bool Item_Initialise ( entity item )

An optimised and generic way to initialise items (loot or permanent)

Parameters

[in] item The item entity to initialise

Returns: True on success, false otherwise. \nore required field: itemdef (faster, preferred) OR classname optional fields: origin, velocity, lifetime, noalign lifetime < 0 means permanent (not loot), lifetime > 0 overrides the default permanent items only: noalign means the item is suspended (won't drop to floor)

Definition at line 27 of file spawning.qc.

{
    if (item.lifetime >= 0)
    {
        ITEM_SET_LOOT(item, true);
        item.pickup_anyway = true; // these are ALWAYS pickable
    }
 
    if (item.itemdef) // no search required
    {
        if (item.itemdef.instanceOfWeapon)
            weapon_defaultspawnfunc(item, item.itemdef);
        else
            StartItem(item, item.itemdef);
    }
    else // fall back to classname search
    {
        FOREACH(Weapons, it.m_canonical_spawnfunc == item.classname,
        {
            weapon_defaultspawnfunc(item, it);
            goto classname_found;
        });
        FOREACH(Items, it.m_canonical_spawnfunc == item.classname,
        {
            StartItem(item, it);
            goto classname_found;
        });
        LOG_FATALF("Invalid classname: %s", item.classname);
        LABEL(classname_found)
    }
 
    if (wasfreed(item))
        return false;
 
    // StartItem sets the default .wait expiry time which is respected by Item_Think()
    if (item.lifetime > 0)
        item.wait = time + item.lifetime;
 
    item.spawnfunc_checked = true;
    return true;
}

References entity(), FOREACH, ITEM_SET_LOOT, LABEL, LOG_FATALF, StartItem(), time, weapon_defaultspawnfunc(), and Weapons.

Referenced by monster_dropitem(), MUTATOR_HOOKFUNCTION(), ok_DropItem(), powerups_DropItem(), RandomItems_ReplaceMapItem(), and RandomItems_SpawnLootItem().

◆ Item_IsDefinitionAllowed()

bool Item_IsDefinitionAllowed ( entity definition )

Checks whether the items with the specified definition are allowed to spawn.

Parameters

[in] definition Item definition to check.

Returns: True items with the specified definition are allowed to spawn, false otherwise.

Definition at line 17 of file spawning.qc.

{
    return !MUTATOR_CALLHOOK(FilterItemDefinition, definition);
}

References entity(), and MUTATOR_CALLHOOK.

Referenced by Item_RandomFromList(), RandomItems_GetRandomInstagibItemClassName(), RandomItems_GetRandomItemClassNameWithProperty(), RandomItems_GetRandomOverkillItemClassName(), and weapon_defaultspawnfunc().

◆ Item_RandomFromList()

entity Item_RandomFromList ( string itemlist )

Takes a space-separated list of netnames, returns the itemdef of one of them (or NULL if none are available).

Definition at line 71 of file spawning.qc.

{
    if(itemlist == "")
        return NULL;
 
    RandomSelection_Init();
    FOREACH_WORD(itemlist, true,
    {
        string item = it;
 
        FOREACH(Weapons, it != WEP_Null && !(it.spawnflags & WEP_FLAG_MUTATORBLOCKED),
        {
            if(it.netname == item || (item == "random" && (it.spawnflags & WEP_FLAG_NORMAL) && !(it.spawnflags & WEP_FLAG_HIDDEN) && !(it.spawnflags & WEP_FLAG_SUPERWEAPON)))
                RandomSelection_AddEnt(it, 1, 1);
        });
        FOREACH(Items, Item_IsDefinitionAllowed(it),
        {
            if(it.netname == item || (item == "random" && (it.spawnflags & ITEM_FLAG_NORMAL) && !it.instanceOfPowerup))
                RandomSelection_AddEnt(it, 1, 1);
        });
    });
    return RandomSelection_chosen_ent;
}

References entity(), FOREACH, FOREACH_WORD, ITEM_FLAG_NORMAL, Item_IsDefinitionAllowed(), NULL, RandomSelection_AddEnt, RandomSelection_chosen_ent, RandomSelection_Init(), Weapons, and WEP_FLAG_MUTATORBLOCKED.

Referenced by monster_dropitem(), and ok_DropItem().

Variable Documentation

◆ lifetime

float lifetime

lifetime < 0 means permanent (not loot), lifetime > 0 overrides the default

Definition at line 10 of file spawning.qh.

◆ m_isexpiring

bool m_isexpiring

Holds whether strength, shield or superweapon timers expire while this item is on the ground.

Definition at line 14 of file spawning.qh.

◆ m_isloot

bool m_isloot

Holds whether item is loot.

Definition at line 12 of file spawning.qh.

◆ startitem_failed

bool startitem_failed

Definition at line 7 of file spawning.qh.

Referenced by StartItem(), W_ThrowNewWeapon(), and weapon_defaultspawnfunc().

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ ITEM_IS_EXPIRING

◆ ITEM_IS_LOOT

◆ ITEM_SET_EXPIRING

◆ ITEM_SET_LOOT

◆ ITEM_SHOULD_KEEP_POSITION

Function Documentation

◆ Item_Initialise()

◆ Item_IsDefinitionAllowed()

◆ Item_RandomFromList()

Variable Documentation

◆ lifetime

◆ m_isexpiring

◆ m_isloot

◆ startitem_failed