spawnfunc.qh File Reference

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

Go to the source code of this file.

Macros
#define	__spawnfunc_spawn_all()
#define	_spawnfunc_check(fld)
#define	_spawnfunc_checktypes(fld)
#define	spawnfunc(id)
#define	SPAWNFUNC_INTERNAL_FIELDS(X)
#define	X(T, fld, def)
#define	X(T, fld, def)
#define	X(T, fld, def)

Functions
void	__spawnfunc_defer (entity prototype, void(entity) constructor)
void	__spawnfunc_spawn (entity prototype)
void	_SV_OnEntityPreSpawnFunction (entity this)
void	g_spawn_queue_spawn ()
	This function simply avoids expanding IL_NEW during compilation for each spawning entity.
	void (entity) __spawnfunc_constructor

Variables
noref string	__fullspawndata
	Not for production use, provides access to a dump of the entity's fields when it is parsed from map data.
noref entity	__spawnfunc_expect
noref int	__spawnfunc_expecting
noref bool	__spawnfunc_first
noref bool	__spawnfunc_unreachable_workaround = true
string	fullspawndata
noref IntrusiveList	g_map_entities
noref IntrusiveList	g_spawn_queue
noref bool	require_spawnfunc_prefix
	If this global exists, only functions with spawnfunc_ name prefix qualify as spawn functions.
bool	spawnfunc_checked

Macro Definition Documentation

__spawnfunc_spawn_all

#define __spawnfunc_spawn_all

(

)

Value:

    MACRO_BEGIN \
    g_map_entities = IL_NEW(); \
    IL_EACH(g_spawn_queue, true, __spawnfunc_spawn(it)); \
MACRO_END

Definition at line 72 of file spawnfunc.qh.

    #define __spawnfunc_spawn_all() MACRO_BEGIN \
        g_map_entities = IL_NEW(); \
        IL_EACH(g_spawn_queue, true, __spawnfunc_spawn(it)); \
    MACRO_END

Referenced by spawnfunc().

_spawnfunc_check

#define _spawnfunc_check

(

fld

)

Value:

if (s == #fld) \
    continue;

Definition at line 34 of file spawnfunc.qh.

    #define _spawnfunc_check(fld) \
        if (s == #fld) \
            continue;

_spawnfunc_checktypes

#define _spawnfunc_checktypes

(

fld

)

Definition at line 32 of file spawnfunc.qh.

spawnfunc

#define spawnfunc

(

id

)

Definition at line 107 of file spawnfunc.qh.

#define spawnfunc(id) \
    void __spawnfunc_##id(entity this); \
    ACCUMULATE void spawnfunc_##id(entity this) \
    { \
        if (!__spawnfunc_first) \
        { \
            __spawnfunc_first = true; \
            static_init_early(); \
        } \
        bool dospawn = true; \
        if (__spawnfunc_expecting > 1) \
            __spawnfunc_expecting = 0; \
        else if (__spawnfunc_expecting) \
        { \
            /* engine call */ \
            if (!g_spawn_queue) \
                g_spawn_queue_spawn(); \
            __spawnfunc_expecting = 0; \
            this = __spawnfunc_expect; \
            __spawnfunc_expect = NULL; \
            dospawn = false; \
        } \
        else \
            /* userland call */ \
            assert(this); \
        if (!this.sourceLoc) \
            this.sourceLoc = __FILE__":"STR(__LINE__); \
        this.classname = #id; \
        if (!this.spawnfunc_checked) \
        { \
            if (__fullspawndata) \
                /* not supported in old DP */ \
                /* must be read inside the real spawnfunc */ \
                this.fullspawndata = __fullspawndata; \
            this.spawnfunc_checked = true; \
            if (this) \
            { \
                /* not worldspawn, delay spawn */ \
                /* clear some dangerous fields (TODO: properly support these in the map!) */ \
                this.think = func_null; \
                this.nextthink = 0; \
                __spawnfunc_defer(this, __spawnfunc_##id); \
            } \
            else \
                /* world might not be "worldspawn" */ \
                this.__spawnfunc_constructor = __spawnfunc_##id; \
        } \
        if (dospawn) \
            __spawnfunc_##id(this); \
        if (__spawnfunc_unreachable_workaround) \
            return; \
    } \
    void __spawnfunc_##id(entity this)

Referenced by spawnfunc().

SPAWNFUNC_INTERNAL_FIELDS

#define SPAWNFUNC_INTERNAL_FIELDS

(

X

)

Value:

X(string, classname, "spawnfunc") \
X(string, target, string_null) \
X(string, target2, string_null) \
X(string, target3, string_null) \
X(string, target4, string_null) \
X(string, targetname, string_null) \

Definition at line 45 of file spawnfunc.qh.

    #define SPAWNFUNC_INTERNAL_FIELDS(X) \
        X(string, classname, "spawnfunc") \
        X(string, target, string_null) \
        X(string, target2, string_null) \
        X(string, target3, string_null) \
        X(string, target4, string_null) \
        X(string, targetname, string_null) \
        /**/

Referenced by __spawnfunc_defer(), and __spawnfunc_spawn().

X [1/3]

#define X	(		T,
			fld,
			def )

Value:

{ \
    e.fld = e.__spawnfunc_##fld; \
    e.__spawnfunc_##fld = def; \
}

Definition at line 54 of file spawnfunc.qh.

X [2/3]

#define X	(		T,
			fld,
			def )

Value:

{ \
    prototype.__spawnfunc_##fld = prototype.fld; \
    prototype.fld = def; \
}

Definition at line 54 of file spawnfunc.qh.

X [3/3]

#define X	(		T,
			fld,
			def )

Value:

.T fld, __spawnfunc_##fld;

Definition at line 54 of file spawnfunc.qh.

Function Documentation

__spawnfunc_defer()

void __spawnfunc_defer	(	entity	prototype,
		void(entity)	constructor )

Definition at line 58 of file spawnfunc.qh.

    {
        IL_PUSH(g_spawn_queue, prototype);
        #define X(T, fld, def) \
        { \
            prototype.__spawnfunc_##fld = prototype.fld; \
            prototype.fld = def; \
        }
        SPAWNFUNC_INTERNAL_FIELDS(X);
        #undef X
        prototype.__spawnfunc_constructor = constructor;
    }

References entity(), g_spawn_queue, IL_PUSH(), SPAWNFUNC_INTERNAL_FIELDS, and X.

__spawnfunc_spawn()

void __spawnfunc_spawn

(

entity

prototype

)

Definition at line 79 of file spawnfunc.qh.

    {
        entity e = new(clone);
        copyentity_qc(prototype, e);
        IL_PUSH(g_map_entities, e);
        #define X(T, fld, def) \
        { \
            e.fld = e.__spawnfunc_##fld; \
            e.__spawnfunc_##fld = def; \
        }
        SPAWNFUNC_INTERNAL_FIELDS(X);
        #undef X
#ifdef SVQC
        _SV_OnEntityPreSpawnFunction(e);
        if (wasfreed(e))
            return;
#endif
        e.__spawnfunc_constructor(e);
    }

References _SV_OnEntityPreSpawnFunction(), copyentity_qc(), entity(), g_map_entities, IL_PUSH(), SPAWNFUNC_INTERNAL_FIELDS, and X.

_SV_OnEntityPreSpawnFunction()

void _SV_OnEntityPreSpawnFunction

(

entity

this

)

References entity().

Referenced by __spawnfunc_spawn().

g_spawn_queue_spawn()

void g_spawn_queue_spawn

(

)

This function simply avoids expanding IL_NEW during compilation for each spawning entity.

Definition at line 100 of file spawnfunc.qh.

{
    g_spawn_queue = IL_NEW();
}

References g_spawn_queue, and IL_NEW.

void()

void

(

entity

)

const

References entity().

Variable Documentation

__fullspawndata

noref string __fullspawndata

Not for production use, provides access to a dump of the entity's fields when it is parsed from map data.

Definition at line 10 of file spawnfunc.qh.

__spawnfunc_expect

noref entity __spawnfunc_expect

Definition at line 39 of file spawnfunc.qh.

__spawnfunc_expecting

noref int __spawnfunc_expecting

Definition at line 38 of file spawnfunc.qh.

__spawnfunc_first

noref bool __spawnfunc_first

Definition at line 105 of file spawnfunc.qh.

__spawnfunc_unreachable_workaround

noref bool __spawnfunc_unreachable_workaround = true

Definition at line 40 of file spawnfunc.qh.

fullspawndata

string fullspawndata

Definition at line 11 of file spawnfunc.qh.

g_map_entities

noref IntrusiveList g_map_entities

Definition at line 71 of file spawnfunc.qh.

Referenced by __spawnfunc_spawn().

g_spawn_queue

noref IntrusiveList g_spawn_queue

Definition at line 43 of file spawnfunc.qh.

Referenced by __spawnfunc_defer(), and g_spawn_queue_spawn().

require_spawnfunc_prefix

noref bool require_spawnfunc_prefix

If this global exists, only functions with spawnfunc_ name prefix qualify as spawn functions.

Definition at line 7 of file spawnfunc.qh.

spawnfunc_checked

bool spawnfunc_checked

Definition at line 8 of file spawnfunc.qh.

Referenced by _SpawnTeam().