replicate.qh File Reference

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

Go to the source code of this file.

Macros
#define	EVAL_REPLICATE(...)
#define	REPLICATE(...)
	Replicates a client cvar into a server field.
#define	REPLICATE_3(fld, type, var)
#define	REPLICATE_4(fld, type, var, func)
#define	REPLICATE_7(fld, type, var, func, check, update, destroy)
#define	REPLICATE_7(fld, type, var, func, create, destroy, after)
#define	REPLICATE_APPLYCHANGE(var, ApplyChange_code)
	Allows setting code that will be executed on cvar value changes.
#define	REPLICATE_bool(fld, var, func)
#define	REPLICATE_bool(fld, var, func)
#define	REPLICATE_float(fld, var, func)
#define	REPLICATE_float(fld, var, func)
#define	REPLICATE_INIT(type, name)
#define	REPLICATE_INIT(type, name)
#define	REPLICATE_int(fld, var, func)
#define	REPLICATE_int(fld, var, func)
#define	REPLICATE_SIMPLE(field, cvarname)
#define	REPLICATE_string(fld, var, func)
#define	REPLICATE_string(fld, var, func)
#define	REPLICATE_vector(fld, var, func)
#define	REPLICATE_vector(fld, var, func)

Functions
ACCUMULATE void	ReplicateVars (entity this, entity store, string thisname, int i)
ACCUMULATE void	ReplicateVars (int mode)
ACCUMULATE void	ReplicateVars_ApplyChange (entity this, entity store, string thisname, int i)
void	ReplicateVars_Send (string cvarname)
void	ReplicateVars_Start ()

Variables
const int	REPLICATEVARS_CHECK = 0
	check if any cvar has changed and sync it with the server
const int	REPLICATEVARS_DESTROY = 1
	destroy data associated with cvars (shutdown)
const int	REPLICATEVARS_SEND_ALL = -1
	sync all cvars with the server (init)
noref float	ReplicateVars_time

Macro Definition Documentation

EVAL_REPLICATE

#define EVAL_REPLICATE

(

...

)

Value:

__VA_ARGS__

Definition at line 24 of file replicate.qh.

REPLICATE

#define REPLICATE

(

...

)

Value:

EVAL_REPLICATE(OVERLOAD(REPLICATE, __VA_ARGS__))

Replicates a client cvar into a server field.

Parameters

fld	The field to replicate into
type	The field type
cvarname
fixup_func((entity	this, string original_value)) optional parameter

Definition at line 23 of file replicate.qh.

Referenced by REPLICATE(), REPLICATE(), REPLICATE(), and REPLICATE().

REPLICATE_3

#define REPLICATE_3	(		fld,
			type,
			var )

Value:

REPLICATE_4(fld, type, var, )

Definition at line 60 of file replicate.qh.

REPLICATE_4

#define REPLICATE_4	(		fld,
			type,
			var,
			func )

Value:

REPLICATE_##type(fld, var, func)

Definition at line 61 of file replicate.qh.

REPLICATE_7 [1/2]

#define REPLICATE_7	(		fld,
			type,
			var,
			func,
			check,
			update,
			destroy )

Value:

void ReplicateVars(int mode) \
{ \
    if (mode == REPLICATEVARS_DESTROY) \
        LAMBDA(destroy) \
    else if (mode == REPLICATEVARS_SEND_ALL || (check)) \
    { \
        ReplicateVars_Send(var); \
        LAMBDA(update) \
    } \
}

Definition at line 79 of file replicate.qh.

        #define REPLICATE_7(fld, type, var, func, create, destroy, after) \
            void ReplicateVars(entity this, entity store, string thisname, int i) \
            { \
                type field = store.fld; \
                if (i < 0) \
                    LAMBDA(destroy) \
                else \
                { \
                    string it = func(argv(i + 1)); \
                    bool current = (thisname == var); \
                    if (i > 0) \
                    { \
                        if (current) \
                            LAMBDA(create) \
                    } \
                    else \
                        stuffcmd(this, strcat("cl_cmd sendcvar ", var, "\n")); \
                    if (current) \
                        LAMBDA(after) \
                } \
                store.fld = field; \
            }

REPLICATE_7 [2/2]

#define REPLICATE_7	(		fld,
			type,
			var,
			func,
			create,
			destroy,
			after )

Value:

void ReplicateVars(entity this, entity store, string thisname, int i) \
{ \
    type field = store.fld; \
    if (i < 0) \
        LAMBDA(destroy) \
    else \
    { \
        string it = func(argv(i + 1)); \
        bool current = (thisname == var); \
        if (i > 0) \
        { \
            if (current) \
                LAMBDA(create) \
        } \
        else \
            stuffcmd(this, strcat("cl_cmd sendcvar ", var, "\n")); \
        if (current) \
            LAMBDA(after) \
    } \
    store.fld = field; \
}

Definition at line 79 of file replicate.qh.

        #define REPLICATE_7(fld, type, var, func, create, destroy, after) \
            void ReplicateVars(entity this, entity store, string thisname, int i) \
            { \
                type field = store.fld; \
                if (i < 0) \
                    LAMBDA(destroy) \
                else \
                { \
                    string it = func(argv(i + 1)); \
                    bool current = (thisname == var); \
                    if (i > 0) \
                    { \
                        if (current) \
                            LAMBDA(create) \
                    } \
                    else \
                        stuffcmd(this, strcat("cl_cmd sendcvar ", var, "\n")); \
                    if (current) \
                        LAMBDA(after) \
                } \
                store.fld = field; \
            }

REPLICATE_APPLYCHANGE

#define REPLICATE_APPLYCHANGE	(		var,
			ApplyChange_code )

Value:

void ReplicateVars_ApplyChange(entity this, entity store, string thisname, int i) \
{ \
    if (thisname == var) \
        LAMBDA(ApplyChange_code) \
}

Allows setting code that will be executed on cvar value changes.

Parameters

cvarname
ApplyChange_code	code meant to be run on cvar value changes

Definition at line 36 of file replicate.qh.

    #define REPLICATE_APPLYCHANGE(var, ApplyChange_code) \
        void ReplicateVars_ApplyChange(entity this, entity store, string thisname, int i) \
        { \
            if (thisname == var) \
                LAMBDA(ApplyChange_code) \
        }

REPLICATE_bool [1/2]

#define REPLICATE_bool	(		fld,
			var,
			func )

Value:

REPLICATE_7(fld, bool,   var, func, fld != cvar(var), fld = cvar(var), )

Definition at line 76 of file replicate.qh.

REPLICATE_bool [2/2]

#define REPLICATE_bool	(		fld,
			var,
			func )

Value:

REPLICATE_7(fld, bool,   var, func, field = boolean(stoi(it)), , )

Definition at line 76 of file replicate.qh.

REPLICATE_float [1/2]

#define REPLICATE_float	(		fld,
			var,
			func )

Value:

REPLICATE_7(fld, float,  var, func, fld != cvar(var), fld = cvar(var), )

Definition at line 75 of file replicate.qh.

REPLICATE_float [2/2]

#define REPLICATE_float	(		fld,
			var,
			func )

Value:

REPLICATE_7(fld, float,  var, func, field = stof(it),          , )

Definition at line 75 of file replicate.qh.

REPLICATE_INIT [1/2]

#define REPLICATE_INIT	(		type,
			name )

Value:

.type name

Definition at line 7 of file replicate.qh.

REPLICATE_INIT [2/2]

#define REPLICATE_INIT	(		type,
			name )

Value:

type name

Definition at line 7 of file replicate.qh.

REPLICATE_int [1/2]

#define REPLICATE_int	(		fld,
			var,
			func )

Value:

REPLICATE_7(fld, int,    var, func, fld != cvar(var), fld = cvar(var), )

Definition at line 77 of file replicate.qh.

REPLICATE_int [2/2]

#define REPLICATE_int	(		fld,
			var,
			func )

Value:

REPLICATE_7(fld, int,    var, func, field = stoi(it),          , )

Definition at line 77 of file replicate.qh.

REPLICATE_SIMPLE

#define REPLICATE_SIMPLE	(		field,
			cvarname )

Value:

    MACRO_BEGIN \
    float thecvar = cvar(cvarname); \
    if (field != thecvar) \
    { \
        ReplicateVars_Send(cvarname); \
        field = thecvar; \
    } \
MACRO_END

Definition at line 125 of file replicate.qh.

        #define REPLICATE_SIMPLE(field, cvarname) MACRO_BEGIN \
            float thecvar = cvar(cvarname); \
            if (field != thecvar) \
            { \
                ReplicateVars_Send(cvarname); \
                field = thecvar; \
            } \
        MACRO_END

REPLICATE_string [1/2]

#define REPLICATE_string	(		fld,
			var,
			func )

Value:

REPLICATE_7(fld, float,  var, func, fld != cvar_string(var), strcpy(fld, cvar_string(var)), strfree(fld))

Definition at line 63 of file replicate.qh.

        #define REPLICATE_string(fld, var, func) \
            REPLICATE_7(fld, string, var, , \
                strcpy(field, it), \
                strfree(field), \
                { \
                    /* also initialize to the default value of func when requesting cvars */ \
                    string s = func(this, strcat(field)); \
                    if (s != field) \
                        strcpy(field, s); \
                } \
            )

REPLICATE_string [2/2]

#define REPLICATE_string	(		fld,
			var,
			func )

Value:

REPLICATE_7(fld, string, var, , \
    strcpy(field, it), \
    strfree(field), \
    { \
        /* also initialize to the default value of func when requesting cvars */ \
        string s = func(this, strcat(field)); \
        if (s != field) \
            strcpy(field, s); \
    } \
)

Definition at line 63 of file replicate.qh.

        #define REPLICATE_string(fld, var, func) \
            REPLICATE_7(fld, string, var, , \
                strcpy(field, it), \
                strfree(field), \
                { \
                    /* also initialize to the default value of func when requesting cvars */ \
                    string s = func(this, strcat(field)); \
                    if (s != field) \
                        strcpy(field, s); \
                } \
            )

REPLICATE_vector [1/2]

#define REPLICATE_vector	(		fld,
			var,
			func )

Value:

REPLICATE_7(fld, vector, var, func, fld != stov(cvar_string(var)), fld = stov(cvar_string(var)), )

Definition at line 74 of file replicate.qh.

REPLICATE_vector [2/2]

#define REPLICATE_vector	(		fld,
			var,
			func )

Value:

REPLICATE_7(fld, vector, var, func, field = stov(it),          , )

Definition at line 74 of file replicate.qh.

Function Documentation

ReplicateVars() [1/2]

ACCUMULATE void ReplicateVars	(	entity	this,
		entity	store,
		string	thisname,
		int	i )

Definition at line 27 of file replicate.qh.

{}

References ACCUMULATE, and entity().

Referenced by ReplicateVars_Start().

ReplicateVars() [2/2]

ACCUMULATE void ReplicateVars

(

int

mode

)

Definition at line 44 of file replicate.qh.

    {
        if (!ReplicateVars_time || time < ReplicateVars_time)
            return;
        ReplicateVars_time = time + 0.8 + random() * 0.4; // check cvars periodically
    }

References ACCUMULATE, random(), ReplicateVars_time, and time.

ReplicateVars_ApplyChange()

ACCUMULATE void ReplicateVars_ApplyChange	(	entity	this,
		entity	store,
		string	thisname,
		int	i )

Definition at line 28 of file replicate.qh.

{}

References ACCUMULATE, and entity().

Referenced by GetCvars().

ReplicateVars_Send()

void ReplicateVars_Send

(

string

cvarname

)

Definition at line 108 of file replicate.qh.

        {
            localcmd(strcat("cl_cmd sendcvar ", cvarname, "\n"));
        }

References localcmd(), and strcat().

ReplicateVars_Start()

void ReplicateVars_Start

(

)

Definition at line 50 of file replicate.qh.

    {
        if (!ReplicateVars_time) // make sure it gets executed only once
        {
            ReplicateVars_time = time;
            ReplicateVars(REPLICATEVARS_SEND_ALL);
        }
    }

References ReplicateVars(), REPLICATEVARS_SEND_ALL, ReplicateVars_time, and time.

Referenced by PostInit().

Variable Documentation

REPLICATEVARS_CHECK

const int REPLICATEVARS_CHECK = 0

check if any cvar has changed and sync it with the server

Definition at line 5 of file replicate.qh.

Referenced by CSQC_UpdateView().

REPLICATEVARS_DESTROY

const int REPLICATEVARS_DESTROY = 1

destroy data associated with cvars (shutdown)

Definition at line 6 of file replicate.qh.

Referenced by Shutdown().

REPLICATEVARS_SEND_ALL

const int REPLICATEVARS_SEND_ALL = -1

sync all cvars with the server (init)

Definition at line 4 of file replicate.qh.

Referenced by ReplicateVars_Start().

ReplicateVars_time

noref float ReplicateVars_time

Definition at line 43 of file replicate.qh.

Referenced by ReplicateVars(), and ReplicateVars_Start().