clientfield_shared.csc File Reference

Go to the source code of this file.

Functions
function	get (field_name)
function	get_player_uimodel (field_name)
function	get_to_player (field_name)
function	register (str_pool_name, str_name, n_version, n_bits, str_type, func_callback, b_host, b_callback_for_zero_when_new)

Function Documentation

get()

function get

(

field_name

)

Definition at line 26 of file clientfield_shared.csc.

get_player_uimodel()

function get_player_uimodel

(

field_name

)

Definition at line 43 of file clientfield_shared.csc.

get_to_player()

function get_to_player

(

field_name

)

Definition at line 38 of file clientfield_shared.csc.

Referenced by MonitorDistance(), on_localplayer_spawned(), on_player_spawned(), onEmpChanged(), player_position_valid(), and ProximityAlarmActivate().

register()

function register	(	str_pool_name	,
		str_name	,
		n_version	,
		n_bits	,
		str_type	,
		func_callback	,
		b_host	,
		b_callback_for_zero_when_new
	)

Description:
"Function Name: register( <str_field_name>, <n_value> )"
"Summary: Register a client field. Client fields are variable bit length fields communicated from server to client. "Module: Clientfield" <br/>"Mandatory Argument(s): <Client field pool name> Which pool the field is allocated from. Currently supported : "world", "actor", "vehicle", "scriptmover"
"Mandatory Argument(s): <name> Unique name to identify the field. <br/>"Mandatory Argument(s): <version> Number indicating version this field was added in - see _version.gsh for defines.
"Mandatory Argument(s): <num bits> How many bits to use for the field. Valid values are in the range of 1-32. Only ask for as many as you need. <br/>"Mandatory Argument(s): <type> Type of the field. Currently supported types "int" or "float"
"Mandatory Argument(s): <callback func> script function to call when field changes. func should be defined as func(localClientNum, oldVal, newVal) <br/>"Mandatory Argument(s): <host only> If true, field callback only happens for the splitscreen host.
"Mandatory Argument(s): <callback for 0 when new> If true, client field will generate callbacks for a value of 0, when the entity is new.

"Example:level clientfield::register( "generator_state", 1 );"
"Single Player / Multi Player: singleplayer"

Definition at line 21 of file clientfield_shared.csc.