spawning.qc File Reference

Source file that contains implementation of the functions related to creation of game items. More...

#include "spawning.qh"
#include <common/mapobjects/subs.qh>
#include <common/mutators/mutator/powerups/_mod.qh>
#include <common/weapons/all.qh>
#include <server/items/items.qh>
#include <server/mutators/_mod.qh>
#include <server/weapons/spawning.qh>
#include <server/world.qh>

Include dependency graph for spawning.qc:

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

Go to the source code of this file.

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

Detailed Description

Source file that contains implementation of the functions related to creation of game items.

Copyright

GNU GPLv2 or any later version.

Definition in file spawning.qc.

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