Header for script parsing functions. More...

#include "common.h"
#include "../game/q_shared.h"

Include dependency graph for scripts.h:

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

Data Structures
struct	value_t
struct	terrainType_t
	Different terrain definitions for footsteps and particles. More...
struct	constListEntry_t
	list of script aliases to register More...

Macros
#define	MEMBER_SIZEOF(TYPE, MEMBER)
#define	V_BASETYPEMASK 0x3F
	Allow to add extra bit into the type.
#define	UFO_MAX 16
#define	AIRCRAFT_NONE -1
#define	UFO_NONE AIRCRAFT_NONE
#define	AIR_SLOT_TYPE_STRINGS
#define	SND_VOLUME_FOOTSTEPS 0.4f

Typedefs
typedef short	ufoType_t

Enumerations
enum	valueTypes_t { V_NULL , V_BOOL , V_CHAR , V_INT , V_INT2 , V_FLOAT , V_POS , V_VECTOR , V_COLOR , V_STRING , V_TRANSLATION_STRING , V_LONGSTRING , V_ALIGN , V_BLEND , V_STYLE , V_FADE , V_SHAPE_SMALL , V_SHAPE_BIG , V_DAMAGE , V_RELABS , V_HUNK_STRING , V_TEAM , V_UFO , V_UFOCRASHED , V_AIRCRAFTTYPE , V_LIST , V_NUM_TYPES , V_ENSURE32BIT = 0xffffffff }
	possible values for parsing functions More...
enum	align_t { ALIGN_UL , ALIGN_UC , ALIGN_UR , ALIGN_CL , ALIGN_CC , ALIGN_CR , ALIGN_LL , ALIGN_LC , ALIGN_LR , ALIGN_UL_RSL , ALIGN_UC_RSL , ALIGN_UR_RSL , ALIGN_CL_RSL , ALIGN_CC_RSL , ALIGN_CR_RSL , ALIGN_LL_RSL , ALIGN_LC_RSL , ALIGN_LR_RSL , ALIGN_LAST }
	We need this here for checking the boundaries from script values. More...
enum	blend_t { BLEND_REPLACE , BLEND_ONE , BLEND_BLEND , BLEND_ADD , BLEND_FILTER , BLEND_INVFILTER , BLEND_LAST }
enum	style_t { STYLE_FACING , STYLE_ROTATED , STYLE_BEAM , STYLE_LINE , STYLE_AXIS , STYLE_CIRCLE , STYLE_LAST }
enum	fade_t { FADE_NONE , FADE_IN , FADE_OUT , FADE_SIN , FADE_SAW , FADE_LAST }
enum	resultStatus_t { RESULT_ERROR = -1 , RESULT_WARNING = -2 , RESULT_OK = 0 }

Functions
template<typename T>
T &	Com_GetValue (void const object, value_t const const value)
template<typename T>
T const &	Com_GetValue (void const const object, value_t const const value)
int	Com_SetValue (void base, const void set, valueTypes_t type, int ofs, size_t size)
int	Com_EParseValue (void base, const char token, valueTypes_t type, int ofs, size_t size)
bool	Com_ParseBlock (const char name, const char text, void base, const value_t values, memPool_t mempool)
bool	Com_ParseBlockToken (const char name, const char text, void base, const value_t values, memPool_t mempool, const char *token)
bool	Com_ParseList (const char text, linkedList_t list)
void *	Com_AlignPtr (const void *memory, valueTypes_t type)
	Align a memory to use a natural address for the data type we will write.
const char *	Com_ValueToStr (const void *base, const valueTypes_t type, const int ofs)
const char *	Com_GetLastParseError (void)
resultStatus_t	Com_ParseValue (void base, const char token, valueTypes_t type, int ofs, size_t size, size_t *writtenBytes)
	Parse a value from a string.
bool	Com_ParseBoolean (const char *token)
	Parses a boolean from a string.
const terrainType_t *	Com_GetTerrainType (const char *textureName)
	Searches the terrain definition if given.
bool	Com_GetConstInt (const char name, int value)
	Searches whether a given value was registered as a string to int mapping.
bool	Com_GetConstIntFromNamespace (const char space, const char variable, int *value)
	Searches whether a given value was registered as a string to int mapping.
const char *	Com_GetConstVariable (const char *space, int value)
	Searches the mapping variable for a given integer value and a namespace.
bool	Com_UnregisterConstVariable (const char *name)
	Removes a registered constant from the script mapping hash table.
void	Com_RegisterConstInt (const char *name, int value)
	Register mappings between script strings and enum values for values of the type `V_INT`.
void	Com_RegisterConstList (const constListEntry_t constList[])
	Registers a list of string aliases.
bool	Com_UnregisterConstList (const constListEntry_t constList[])
	Unregisters a list of string aliases.
void	Com_ParseScripts (bool onlyServer)
const char *	Com_EParse (const char *text, const char errhead, const char errinfo, char target=0, size_t size=0)
	Parsing function that prints an error message when there is no text in the buffer.
const char *	Com_GetRandomMapAssemblyNameForCraft (const char *craftID)
	Returns the name of an aircraft or an ufo that is used in the ump files for the random map assembly.
const char *	Com_GetRandomMapAssemblyNameForCrashedCraft (const char *craftID)
ufoType_t	Com_UFOShortNameToID (const char *token)
	Translate short name to UFO type.
const char *	Com_UFOTypeToShortName (ufoType_t type)
	Translate UFO type to short name.
const char *	Com_UFOCrashedTypeToShortName (ufoType_t type)
	Translate UFO type to short name when UFO is crashed.
short	Com_GetUfoIdsNum (void)
short	Com_GetDropShipIdsNum (void)
short	Com_GetHumanAircraftIdsNum (void)
int	Com_GetScriptChecksum (void)
void	Com_Shutdown (void)
const ugv_t *	Com_GetUGVByIDSilent (const char *ugvID)
	Searches an UGV definition by a given script id and returns the pointer to the global data.
const ugv_t *	Com_GetUGVByID (const char *ugvID)
	Searches an UGV definition by a given script id and returns the pointer to the global data.
const char *	Com_DropShipTypeToShortName (humanAircraftType_t type)
	Translate DropShip type to short name.
humanAircraftType_t	Com_DropShipShortNameToID (const char *token)
	Translate DropShip type to short name.
void	Com_GetCharacterValues (const char teamDefition, character_t chr)
	Assign character values, 3D models and names to a character.
bool	Com_GetCharacterModel (character_t *chr)
const teamDef_t *	Com_GetTeamDefinitionByID (const char *team)
	Returns the teamDef pointer for the searched team id - or nullptr if not found in the teamDef array.
const chrTemplate_t *	Com_GetCharacterTemplateByID (const char *chrTemplate)
	Returns the chrTemplate pointer for the given id - or nullptr if not found in the chrTemplates array.

Variables
const char *const	vt_names []
	possible values for parsing functions
const char *const	align_names []
const char *const	blend_names []
const char *const	style_names []
const char *const	fade_names []
const char *const	longlines_names []
const char *const	name_strings []

Detailed Description

Header for script parsing functions.

Definition in file scripts.h.

Macro Definition Documentation

◆ AIR_SLOT_TYPE_STRINGS

#define AIR_SLOT_TYPE_STRINGS

Value:

{ \
"base_missile", \
"base_laser", \
"weapon", \
"shield", \
"electronics", \
"pilot", \
"ammo", \
"base_ammo_missile", \
"base_ammo_laser" \
}

Definition at line 154 of file scripts.h.

◆ AIRCRAFT_NONE

#define AIRCRAFT_NONE -1

Definition at line 147 of file scripts.h.

Referenced by Com_GetAircraftIdNum(), Com_GetCrashedAircraftIdNum(), Com_GetHumanCraftIdNum(), Com_ParseAircraftNames(), Com_ParseValue(), and Com_SetValue().

◆ MEMBER_SIZEOF

#define MEMBER_SIZEOF	(		TYPE,
			MEMBER )

Value:

sizeof(((TYPE*)0)->MEMBER)

Definition at line 34 of file scripts.h.

Referenced by AIR_ParseAircraft(), UI_SpriteExists(), and WEB_ListCGameFilesCallback().

◆ SND_VOLUME_FOOTSTEPS

#define SND_VOLUME_FOOTSTEPS 0.4f

Definition at line 212 of file scripts.h.

Referenced by Com_ParseTerrain(), LE_PlayFootStepSound(), and LE_PlaySoundFileForContents().

◆ UFO_MAX

#define UFO_MAX 16

Definition at line 146 of file scripts.h.

Referenced by Com_ParseAircraftNames(), CP_MissionChooseUFO(), NAT_ScriptSanityCheck(), TEST_F(), TEST_F(), TEST_F(), and UFO_GetOneAvailableUFOForMission().

◆ UFO_NONE

#define UFO_NONE AIRCRAFT_NONE

Definition at line 148 of file scripts.h.

Referenced by AIR_ParseAircraft(), Com_ParseValue(), Com_SetValue(), CP_MissionBegin(), CP_MissionChooseUFO(), CP_SupplyMissionCreate(), and UFO_GetOneAvailableUFOForMission().

◆ V_BASETYPEMASK

#define V_BASETYPEMASK 0x3F

Allow to add extra bit into the type.

Note: If valueTypes_t is bigger than 63 the mask must be changed

See also: valueTypes_t

Definition at line 41 of file scripts.h.

Referenced by UI_InitRawActionValue(), UI_NodeSetPropertyFromRAW(), and UI_ParseProperty().

Typedef Documentation

◆ ufoType_t

typedef short ufoType_t

Definition at line 145 of file scripts.h.

Enumeration Type Documentation

◆ align_t

enum align_t

We need this here for checking the boundaries from script values.

possible align values - see also align_names

Enumerator
ALIGN_UL
ALIGN_UC
ALIGN_UR
ALIGN_CL
ALIGN_CC
ALIGN_CR
ALIGN_LL
ALIGN_LC
ALIGN_LR
ALIGN_UL_RSL
ALIGN_UC_RSL
ALIGN_UR_RSL
ALIGN_CL_RSL
ALIGN_CC_RSL
ALIGN_CR_RSL
ALIGN_LL_RSL
ALIGN_LC_RSL
ALIGN_LR_RSL
ALIGN_LAST

Definition at line 89 of file scripts.h.

◆ blend_t

enum blend_t

possible blend modes - see also blend_names

Enumerator
BLEND_REPLACE
BLEND_ONE
BLEND_BLEND
BLEND_ADD
BLEND_FILTER
BLEND_INVFILTER
BLEND_LAST

Definition at line 113 of file scripts.h.

◆ fade_t

enum fade_t

Enumerator
FADE_NONE
FADE_IN
FADE_OUT
FADE_SIN
FADE_SAW
FADE_LAST

Definition at line 135 of file scripts.h.

◆ resultStatus_t

enum resultStatus_t

Enumerator
RESULT_ERROR
RESULT_WARNING
RESULT_OK

Definition at line 184 of file scripts.h.

◆ style_t

enum style_t

Enumerator
STYLE_FACING	rotates a sprint into the camera direction
STYLE_ROTATED	use the particle angles vector
STYLE_BEAM
STYLE_LINE
STYLE_AXIS
STYLE_CIRCLE
STYLE_LAST

Definition at line 124 of file scripts.h.

◆ valueTypes_t

enum valueTypes_t

possible values for parsing functions

See also: vt_names; vt_sizes

Enumerator
V_NULL
V_BOOL
V_CHAR
V_INT
V_INT2
V_FLOAT
V_POS
V_VECTOR
V_COLOR
V_STRING
V_TRANSLATION_STRING	remove _ but don't translate
V_LONGSTRING	not buffer safe - use this only for menu node data array values!
V_ALIGN
V_BLEND
V_STYLE
V_FADE
V_SHAPE_SMALL	space a weapon allocates in the inventory shapes, w, h
V_SHAPE_BIG	inventory shape, x, y, w, h
V_DAMAGE
V_RELABS	relative (e.g. 1.50) and absolute (e.g. +15) values
V_HUNK_STRING	store the string in a mem pool
V_TEAM	team string to int mapper
V_UFO	Valid ufo types. Note Use the same values for the names as we are already using in the scriptfiles here, otherwise they are not translatable because they don't appear in the po files Every ufotype (id) that doesn't have nogeoscape set to true must have an assembly in the ufocrash[dn].ump files
V_UFOCRASHED
V_AIRCRAFTTYPE
V_LIST
V_NUM_TYPES
V_ENSURE32BIT

Definition at line 48 of file scripts.h.

Function Documentation

◆ Com_AlignPtr()

void * Com_AlignPtr	(	const void *	memory,
		valueTypes_t	type )

Align a memory to use a natural address for the data type we will write.

Note: it speed up data read, and fix crash on PPC processors

Definition at line 437 of file scripts.cpp.

References Sys_Error(), type, V_NULL, V_NUM_TYPES, and vt_aligns.

Referenced by CL_ParsePtlCmds(), Com_ParseValue(), Com_SetValue(), Com_ValueToStr(), UI_InitRawActionValue(), and UI_ParseProperty().

◆ Com_DropShipShortNameToID()

humanAircraftType_t Com_DropShipShortNameToID ( const char * token )

Translate DropShip type to short name.

Returns: Will always return a valid human aircraft type or errors out if the given token can't be mapped to an human aircraft type

See also: Com_DropShipTypeToShortName

Definition at line 3307 of file scripts.cpp.

References Com_ParseValue(), and V_AIRCRAFTTYPE.

Referenced by Com_ParseEquipment(), GAME_GetImportData(), and cgame_import_t::humanAircraftType_t().

◆ Com_DropShipTypeToShortName()

const char * Com_DropShipTypeToShortName ( humanAircraftType_t type )

Translate DropShip type to short name.

See also: Com_DropShipShortNameToID

Definition at line 3319 of file scripts.cpp.

References Com_ValueToStr(), type, and V_AIRCRAFTTYPE.

Referenced by GAME_GetImportData().

◆ Com_EParse()

const char * Com_EParse	(	const char **	text,
		const char *	errhead,
		const char *	errinfo,
		char *	target,
		size_t	size )

Parsing function that prints an error message when there is no text in the buffer.

See also: Com_Parse

Definition at line 277 of file scripts.cpp.

References Com_Parse(), and Com_Printf().

Referenced by CL_ParseLanguages(), CL_ParseMessageID(), CL_ParseParticle(), CL_ParsePtlCmds(), CL_ParseSequence(), Com_EParse_(), Com_ParseActorModels(), Com_ParseActorNames(), Com_ParseActorSounds(), Com_ParseAircraftNames(), Com_ParseArmourOrResistance(), Com_ParseBlock(), Com_ParseBlockToken(), Com_ParseBodyPart(), Com_ParseBodyTemplate(), Com_ParseCharacterTemplate(), Com_ParseDamageTypes(), Com_ParseEquipment(), Com_ParseFire(), Com_ParseFireDefinition(), Com_ParseGameTypes(), Com_ParseImplant(), Com_ParseItem(), Com_ParseMapDefinition(), Com_ParseTeam(), Com_ParseTerrainDefinition(), SV_GetCvarToken(), SV_GetTileFromTileSet(), SV_GetTilesFromTileSet(), SV_ParseAssembly(), SV_ParseAssemblySeeds(), SV_ParseMapTile(), SV_ParseMapTileSet(), UI_ParseActionList(), UI_ParseCallAction(), UI_ParseComponent(), UI_ParseEventProperty(), UI_ParseExcludeRect(), UI_ParseFont(), UI_ParseNode(), UI_ParseNodeBody(), UI_ParseNodeProperties(), UI_ParseProperty(), UI_ParseSetAction(), and UI_ParseUIModel().

◆ Com_EParseValue()

int Com_EParseValue	(	void *	base,
		const char *	token,
		valueTypes_t	type,
		int	ofs,
		size_t	size )

Note: translatable string are marked with _ at the beginning
menu exampleName

{

string "_this is translatable"

}

Definition at line 964 of file scripts.cpp.

References Com_ParseValue(), Com_Printf(), parseErrorMessage, RESULT_ERROR, RESULT_OK, RESULT_WARNING, Sys_Error(), and type.

Referenced by CL_ParseMapParticle(), CL_ParsePtlCmds(), CL_SpawnParseEntitystring(), Com_ParseBlockToken(), Com_ParseBodyPart(), Com_ParseCharacterTemplate(), GAME_GetImportData(), cgame_import_t::int(), SEQ_ExecuteCamera(), SEQ_ExecuteModel(), SEQ_ExecuteObj2D(), UI_InitRawActionValue(), UI_ParseExcludeRect(), UI_ParseFont(), UI_ParseUIModel(), and WEB_ListCGameFilesCallback().

◆ Com_GetCharacterModel()

bool Com_GetCharacterModel ( character_t * chr )

Definition at line 2358 of file scripts.cpp.

References character_t::body, teamDef_t::model_t::body, character_t::bodySkin, teamDef_t::model_t::bodySkin, Com_GiveModel(), character_t::gender, character_t::head, teamDef_t::model_t::head, character_t::headSkin, teamDef_t::model_t::headSkin, character_t::path, teamDef_t::model_t::path, Q_strncpyz(), and character_t::teamDef.

Referenced by Com_GetCharacterValues(), and GAME_LoadCharacter().

◆ Com_GetCharacterTemplateByID()

const chrTemplate_t * Com_GetCharacterTemplateByID ( const char * chrTemplate )

Returns the chrTemplate pointer for the given id - or nullptr if not found in the chrTemplates array.

Parameters

[in] chrTemplate The character template id (given in ufo-script files)

Definition at line 2809 of file scripts.cpp.

References Com_Printf(), csi, i, Q_streq, and Q_strnull().

Referenced by Com_ParseTeam().

◆ Com_GetCharacterValues()

void Com_GetCharacterValues	(	const char *	teamDefition,
		character_t *	chr )

Assign character values, 3D models and names to a character.

Parameters

[in]	teamDefition	The team definition id to use to generate the character values.
[in,out]	chr	The character that should get the paths to the different models/skins.

See also: Com_GiveName; Com_GiveModel

Definition at line 2408 of file scripts.cpp.

References ACTOR_SIZE_INVALID, ACTOR_SIZE_NORMAL, Com_Error(), Com_GetCharacterModel(), Com_GetGender(), Com_GetTeamDefinitionByID(), Com_GiveName(), ERR_DROP, character_t::fieldSize, character_t::gender, character_t::name, NAME_LAST, Q_strcat(), Q_strncpyz(), teamDef_t::size, and character_t::teamDef.

Referenced by CL_GenerateCharacter(), and SV_InitGameProgs().

◆ Com_GetConstInt()

bool Com_GetConstInt	(	const char *	name,
		int *	value )

Searches whether a given value was registered as a string to int mapping.

Parameters

[in]	name	The name of the string mapping (maybe including a namespace)
[out]	value	The mapped integer if found, not touched if the given string was found in the registered values.

Returns: True if the value is found.

See also: Com_RegisterConstInt; Com_ParseValue

Definition at line 74 of file scripts.cpp.

References Com_ConstIntGetVariable(), com_constNameInt_hash, Com_HashKey(), CONSTNAMEINT_HASH_SIZE, hash, name, and Q_streq.

Referenced by cgame_import_t::bool(), Com_GetConstIntFromNamespace(), Com_ParseValue(), GAME_GetImportData(), SV_InitGameProgs(), and TEST_F().

◆ Com_GetConstIntFromNamespace()

bool Com_GetConstIntFromNamespace	(	const char *	space,
		const char *	variable,
		int *	value )

Searches whether a given value was registered as a string to int mapping.

Parameters

[in]	space	The namespace of the mapping variable
[in]	variable	The name of the string mapping
[out]	value	The mapped integer if found, not touched if the given string was found in the registered values.

Returns: True if the value is found.

See also: Com_RegisterConstInt; Com_ParseValue; Com_GetConstInt

Definition at line 103 of file scripts.cpp.

References Com_GetConstInt(), Q_strnull(), and va().

Referenced by cgame_import_t::bool(), GAME_GetImportData(), GAME_LoadCharacter(), and SV_InitGameProgs().

◆ Com_GetConstVariable()

const char * Com_GetConstVariable	(	const char *	space,
		int	value )

Searches the mapping variable for a given integer value and a namespace.

Parameters

[in]	space	The namespace to search in - might not be `nullptr` or empty.
[in]	value	The mapped integer

Note: only variables with a namespace given are found here

See also: Com_RegisterConstInt; Com_ParseValue

Definition at line 122 of file scripts.cpp.

References com_constNameInt, com_constNameInt_t::fullname, com_constNameInt_t::name, com_constNameInt_t::next, and com_constNameInt_t::value.

Referenced by GAME_GetImportData(), GAME_SaveCharacter(), SV_InitGameProgs(), and TEST_F().

◆ Com_GetDropShipIdsNum()

short Com_GetDropShipIdsNum ( void )

Definition at line 576 of file scripts.cpp.

References aircraftIdsNum, and CRAFT_DROP.

Referenced by GAME_GetImportData(), and cgame_import_t::short().

◆ Com_GetHumanAircraftIdsNum()

short Com_GetHumanAircraftIdsNum ( void )

Definition at line 581 of file scripts.cpp.

References aircraftIdsNum, CRAFT_DROP, and CRAFT_INTER.

Referenced by GAME_GetImportData(), and cgame_import_t::short().

◆ Com_GetLastParseError()

const char * Com_GetLastParseError ( void )

Returns the last error message

Returns: string that contains the last error message

Definition at line 428 of file scripts.cpp.

References parseErrorMessage.

Referenced by UI_NodeSetProperty(), and UI_ParseProperty().

◆ Com_GetRandomMapAssemblyNameForCraft()

const char * Com_GetRandomMapAssemblyNameForCraft ( const char * craftID )

Returns the name of an aircraft or an ufo that is used in the ump files for the random map assembly.

See also: cvar rm_drop, rm_ufo, rm_crashed

Note: Uses a static buffer - so after you got the name you should ensure that you put it into a proper location. Otherwise it will get overwritten with the next call of this function.

Definition at line 3277 of file scripts.cpp.

References va().

Referenced by GAME_GetImportData(), TEST_F(), GameTest::testCountSpawnpointsForMapWithAssembly(), and GameTest::testCountSpawnpointsForMapWithAssemblyAndAircraft().

◆ Com_GetRandomMapAssemblyNameForCrashedCraft()

const char * Com_GetRandomMapAssemblyNameForCrashedCraft ( const char * craftID )

Todo: implement this in a better way

Definition at line 3285 of file scripts.cpp.

References Q_streq.

Referenced by GAME_GetImportData().

◆ Com_GetScriptChecksum()

int Com_GetScriptChecksum ( void )

Definition at line 3717 of file scripts.cpp.

References Com_BlockChecksum(), FS_GetFileData(), and LittleLong.

Referenced by CL_CanMultiplayerStart(), and SV_Map().

◆ Com_GetTeamDefinitionByID()

const teamDef_t * Com_GetTeamDefinitionByID ( const char * team )

Returns the teamDef pointer for the searched team id - or nullptr if not found in the teamDef array.

Parameters

[in] team The team id (given in ufo-script files)

Definition at line 2345 of file scripts.cpp.

References Com_Printf(), csi, i, teamDef_t::id, and Q_streq.

Referenced by Com_GetCharacterValues(), GAME_GetImportData(), GAME_ItemIsUseable(), GAME_LoadCharacter(), TEST_F(), and TEST_F().

◆ Com_GetTerrainType()

const terrainType_t * Com_GetTerrainType ( const char * textureName )

Searches the terrain definition if given.

Parameters

[in] textureName The terrain definition id from script files which is the texture name relative to base/textures

Definition at line 3067 of file scripts.cpp.

References Com_HashKey(), hash, Q_streq, TERRAIN_HASH_SIZE, and terrainTypesHash.

Referenced by Com_ParseTerrain(), LE_PlaySoundFileAndParticleForSurface(), SV_GetBounceFraction(), and SV_GetFootstepSound().

◆ Com_GetUfoIdsNum()

short Com_GetUfoIdsNum ( void )

Definition at line 571 of file scripts.cpp.

References aircraftIdsNum, and CRAFT_UFO.

Referenced by GAME_GetImportData(), and TEST_F().

◆ Com_GetUGVByID()

const ugv_t * Com_GetUGVByID ( const char * ugvID )

Searches an UGV definition by a given script id and returns the pointer to the global data.

Parameters

[in] ugvID The script id of the UGV definition you are looking for

Returns: ugv_t pointer or nullptr if not found.

Definition at line 3381 of file scripts.cpp.

References Com_GetUGVByIDSilent(), Com_Printf(), and csi.

Referenced by GAME_GetImportData(), and TEST_F().

◆ Com_GetUGVByIDSilent()

const ugv_t * Com_GetUGVByIDSilent ( const char * ugvID )

Searches an UGV definition by a given script id and returns the pointer to the global data.

Parameters

[in] ugvID The script id of the UGV definition you are looking for

Returns: ugv_t pointer or nullptr if not found.

Note: This function gives no warning on null name or if no ugv found

Definition at line 3362 of file scripts.cpp.

References csi, i, ugv_t::id, and Q_streq.

Referenced by Com_GetUGVByID(), GAME_AppendTeamMember(), and GAME_GetImportData().

◆ Com_GetValue() [1/2]

template<typename T>

T & Com_GetValue	(	void *const	object,
		value_t const *const	value )

inline

Definition at line 174 of file scripts.h.

References value_t::ofs.

Referenced by Com_GetValue(), Com_ParseBlockToken(), uiFuncNode::onLoaded(), SEQ_ExecuteObj2D(), UI_AddListener(), UI_DeleteNode(), UI_ExecuteCallAction(), UI_GetFloatFromNodeProperty(), UI_GetStringFromNodeProperty(), UI_NodeSetProperty(), UI_NodeSetPropertyFromActionValue(), UI_NodeSetPropertyFromRAW(), UI_ParseEventProperty(), UI_ParseFont(), UI_ParseProperty(), UI_ParseUIModel(), and UI_RemoveListener().

◆ Com_GetValue() [2/2]

template<typename T>

T const & Com_GetValue	(	void const *const	object,
		value_t const *const	value )

inline

Definition at line 179 of file scripts.h.

References Com_GetValue().

◆ Com_ParseBlock()

bool Com_ParseBlock	(	const char *	name,
		const char **	text,
		void *	base,
		const value_t *	values,
		memPool_t *	mempool )

Definition at line 1393 of file scripts.cpp.

References Com_EParse(), Com_Parse(), Com_ParseBlockToken(), Com_Printf(), and name.

Referenced by CL_ParseActorSkin(), Com_ParseInventory(), Com_ParseTerrain(), Com_ParseUGVs(), GAME_GetImportData(), GAME_ParseModes(), and TUT_ParseTutorials().

◆ Com_ParseBlockToken()

bool Com_ParseBlockToken	(	const char *	name,
		const char **	text,
		void *	base,
		const value_t *	values,
		memPool_t *	mempool,
		const char *	token )

Definition at line 1311 of file scripts.cpp.

References Com_EParse(), Com_EParseValue(), Com_GetValue(), Com_ParseList(), Com_Printf(), Com_UnParseLastToken(), Mem_PoolStrDupTo, name, Q_streq, v, V_HUNK_STRING, V_LIST, and V_TRANSLATION_STRING.

Referenced by cgame_import_t::bool(), Com_ParseBlock(), Com_ParseBodyPart(), Com_ParseEquipment(), Com_ParseFire(), Com_ParseGameTypes(), Com_ParseImplant(), Com_ParseItem(), Com_ParseItemEffect(), Com_ParseMapDefinition(), Com_ParseTeam(), and GAME_GetImportData().

◆ Com_ParseBoolean()

bool Com_ParseBoolean ( const char * token )

Parses a boolean from a string.

Parameters

token The token to convert into a boolean

Returns: false if the string could not get parsed

Definition at line 986 of file scripts.cpp.

References Com_ParseValue(), RESULT_ERROR, and V_BOOL.

Referenced by cgame_import_t::bool(), GAME_GetImportData(), and HUD_RemainingTUs_f().

◆ Com_ParseList()

bool Com_ParseList	(	const char **	text,
		linkedList_t **	list )

Parse tokens between '(' and ')' and return them into a linked list. It the list is not well formed, the returned list is null.

Parameters

[in]	text	Pointer to a token stream
[out]	list	list to return

Returns: True if the list is well formed, else false.

Definition at line 1363 of file scripts.cpp.

References Com_GetToken(), Com_NextToken(), Com_Printf(), LIST_AddString(), LIST_Delete(), TT_BEGIN_LIST, TT_CONTENT, TT_END_LIST, TT_EOF, and type.

Referenced by cgame_import_t::bool(), CL_ParseLanguages(), CL_ParseSequence(), Com_ParseActorModels(), Com_ParseActorNames(), Com_ParseBlockToken(), Com_ParseBodyPart(), Com_ParseEquipment(), Com_ParseMapDefinition(), Com_ParseTeam(), GAME_GetImportData(), M_ParseMusic(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

◆ Com_ParseScripts()

void Com_ParseScripts ( bool onlyServer )

See also: CL_ParseClientData; CL_ParseScriptFirst; CL_ParseScriptSecond; Qcommon_Init

Definition at line 3619 of file scripts.cpp.

References aircraftIdsNum, CL_ParseClientData(), Com_AddObjectLinks(), Com_ParseActorNames(), Com_ParseAircraftNames(), Com_ParseBodyTemplate(), Com_ParseCharacterTemplate(), Com_ParseDamageTypes(), Com_ParseEquipment(), Com_ParseGameTypes(), Com_ParseImplant(), Com_ParseInventory(), Com_ParseItem(), Com_ParseMapDefinition(), Com_ParseTeam(), Com_ParseTerrain(), Com_ParseTerrainDefinition(), Com_ParseUGVs(), Com_ParseVersion(), Com_Printf(), csi, dropIdsTable, FS_BuildFileList(), FS_NextScriptHeader(), interIdsTable, INVSH_InitCSI(), name, NONE, OBJZERO, Q_streq, Sys_Error(), type, ufoIdsTable, and versionParsed.

Referenced by Qcommon_Init(), CampaignTest::SetUpTestCase(), CharacterTest::SetUpTestCase(), FootStepTest::SetUpTestCase(), GameTest::SetUpTestCase(), InventoryTest::SetUpTestCase(), MapDefMassRMATest::SetUpTestCase(), MapDefStatsTest::SetUpTestCase(), MapDefTest::SetUpTestCase(), ParticleTest::SetUpTestCase(), RandomMapAssemblyTest::SetUpTestCase(), RoutingTest::SetUpTestCase(), ScriptTest::SetUpTestCase(), and WebApiTest::SetUpTestCase().

◆ Com_ParseValue()

resultStatus_t Com_ParseValue	(	void *	base,
		const char *	token,
		valueTypes_t	type,
		int	ofs,
		size_t	size,
		size_t *	writtenBytes )

Parse a value from a string.

Parameters

[in]	base	The start pointer to a given data type (typedef, struct) where the parsed data is stored
[in]	token	The data which should be parsed
[in]	type	The data type that should be parsed
[in]	ofs	The offset for the value
[in]	size	The expected size of the data type. If 0, no checks are done
[out]	writtenBytes

Returns: A resultStatus_t value

Note: instead of , this function separate error message and write byte result

Todo: This function has much in common with Com_SetValue. Refactor them !

Definition at line 656 of file scripts.cpp.

References AIRCRAFT_NONE, ALIGN_LAST, align_names, BLEND_LAST, blend_names, Com_AlignPtr(), Com_GetConstInt(), Com_GetCrashedUfoIdNum(), Com_GetHumanCraftIdNum(), Com_GetUfoIdNum(), Com_Printf(), csi, f, FADE_LAST, fade_names, int(), MAX_VAR, parseErrorMessage, Q_streq, Q_strncpyz(), RESULT_ERROR, RESULT_OK, RESULT_WARNING, SHAPE_BIG_MAX_HEIGHT, SHAPE_BIG_MAX_WIDTH, SHAPE_SMALL_MAX_HEIGHT, SHAPE_SMALL_MAX_WIDTH, STYLE_LAST, style_names, Sys_Error(), TEAM_ALIEN, TEAM_CIVILIAN, TEAM_PHALANX, type, UFO_NONE, UFO_SIZE_T, V_AIRCRAFTTYPE, V_ALIGN, V_BLEND, V_BOOL, V_CHAR, V_COLOR, V_DAMAGE, V_FADE, V_FLOAT, V_HUNK_STRING, V_INT, V_INT2, V_LONGSTRING, V_NULL, V_POS, V_RELABS, V_SHAPE_BIG, V_SHAPE_SMALL, V_STRING, V_STYLE, V_TEAM, V_TRANSLATION_STRING, V_UFO, V_UFOCRASHED, V_VECTOR, vt_aligns, and vt_sizes.

Referenced by Com_DropShipShortNameToID(), Com_EParseValue(), Com_ParseBoolean(), Com_UFOShortNameToID(), TEST_F(), UI_MaterialEditorChangeValue_f(), UI_NodeSetProperty(), UI_ParseProperty(), and UI_PushDropDownWindow_f().

◆ Com_RegisterConstInt()

void Com_RegisterConstInt	(	const char *	name,
		int	value )

Register mappings between script strings and enum values for values of the type V_INT.

Parameters

name	The name of the script entry to map to an integer. This can also include a namespace prefix for the case we want to map back an integer to a string from a specific namespace. In case this string is equipped with a namespace, the string is in the form "namespace::variable"
value	The value to map the given name to

Note: You still can't register the same name twice even if you put it into different namespaces (yet). The namespaces are only for converting an integer back into a string.

See also: Com_GetConstInt; Com_UnregisterConstVariable

Definition at line 198 of file scripts.cpp.

References com_aliasSysPool, Com_ConstIntGetVariable(), com_constNameInt, com_constNameInt_hash, Com_HashKey(), Com_Printf(), CONSTNAMEINT_HASH_SIZE, com_constNameInt_t::fullname, hash, com_constNameInt_t::hash_next, Mem_PoolAllocType, Mem_StrDup, com_constNameInt_t::name, name, com_constNameInt_t::next, Q_streq, Q_strncpyz(), and com_constNameInt_t::value.

Referenced by Com_RegisterConstList(), GAME_GetImportData(), SV_InitGameProgs(), TEST_F(), UI_RegisterAbstractNode(), UI_RegisterBaseInventoryNode(), UI_RegisterPanelNode(), UI_RegisterSpinnerNode(), and UI_RegisterTextNode().

◆ Com_RegisterConstList()

void Com_RegisterConstList ( const constListEntry_t constList[] )

Registers a list of string aliases.

Parameters

[in] constList Array of string => int mappings. Must be terminated with a nullptr string ({nullptr, -1}) line

See also: constListEntry_t

Definition at line 253 of file scripts.cpp.

References Com_RegisterConstInt(), i, constListEntry_t::name, and name.

Referenced by GAME_GetImportData(), GAME_LoadCharacter(), GAME_SaveCharacter(), TEST_F(), and cgame_import_t::void().

◆ Com_SetValue()

int Com_SetValue	(	void *	base,
		const void *	set,
		valueTypes_t	type,
		int	ofs,
		size_t	size )

Parameters

[in]	base	The start pointer to a given data type (typedef, struct)
[in]	set	The data which should be parsed
[in]	type	The data type that should be parsed
[in]	ofs	The offset for the value
[in]	size	The expected size of the data type. If 0, no checks are done

See also: Com_ValueToStr

Note: The offset is most likely given by the offsetof macro

Definition at line 1009 of file scripts.cpp.

References AIRCRAFT_NONE, Com_AlignPtr(), Com_GetCrashedUfoIdNum(), Com_GetHumanCraftIdNum(), Com_GetUfoIdNum(), Com_Printf(), int(), len, MAX_VAR, Q_streq, Q_strncpyz(), SHAPE_BIG_MAX_HEIGHT, SHAPE_SMALL_MAX_HEIGHT, Sys_Backtrace(), Sys_Error(), TEAM_ALIEN, TEAM_CIVILIAN, TEAM_PHALANX, type, UFO_NONE, UFO_SIZE_T, V_AIRCRAFTTYPE, V_ALIGN, V_BLEND, V_BOOL, V_CHAR, V_COLOR, V_DAMAGE, V_FADE, V_FLOAT, V_INT, V_INT2, V_LONGSTRING, V_NULL, V_POS, V_SHAPE_BIG, V_SHAPE_SMALL, V_STRING, V_STYLE, V_TEAM, V_UFO, V_UFOCRASHED, V_VECTOR, vt_aligns, and vt_sizes.

Referenced by CL_ParticleFunction(), and UI_NodeSetPropertyFromRAW().

◆ Com_Shutdown()

void Com_Shutdown ( void )

Definition at line 3732 of file scripts.cpp.

References com_constNameInt, com_constNameInt_hash, OBJZERO, terrainTypesHash, and versionParsed.

Referenced by Qcommon_Shutdown(), and TEST_Shutdown().

◆ Com_UFOCrashedTypeToShortName()

const char * Com_UFOCrashedTypeToShortName ( ufoType_t type )

Translate UFO type to short name when UFO is crashed.

See also: Com_UFOTypeToShortName

Definition at line 3351 of file scripts.cpp.

References Com_ValueToStr(), type, and V_UFOCRASHED.

Referenced by GAME_GetImportData().

◆ Com_UFOShortNameToID()

ufoType_t Com_UFOShortNameToID ( const char * token )

Translate short name to UFO type.

See also: UFO_TypeToName; Com_UFOTypeToShortName

Definition at line 3329 of file scripts.cpp.

References Com_ParseValue(), and V_UFO.

Referenced by GAME_GetImportData(), and cgame_import_t::ufoType_t().

◆ Com_UFOTypeToShortName()

const char * Com_UFOTypeToShortName ( ufoType_t type )

Translate UFO type to short name.

See also: UFO_TypeToName; Com_UFOShortNameToID

Definition at line 3342 of file scripts.cpp.

References Com_ValueToStr(), type, and V_UFO.

Referenced by GAME_GetImportData().

◆ Com_UnregisterConstList()

bool Com_UnregisterConstList ( const constListEntry_t constList[] )

Unregisters a list of string aliases.

Parameters

[in] constList Array of string => int mappings. Must be terminated with a nullptr string ({nullptr, -1}) line

See also: constListEntry_t

Definition at line 237 of file scripts.cpp.

References Com_UnregisterConstVariable(), i, constListEntry_t::name, and name.

Referenced by cgame_import_t::bool(), GAME_GetImportData(), GAME_LoadCharacter(), GAME_SaveCharacter(), and TEST_F().

◆ Com_UnregisterConstVariable()

bool Com_UnregisterConstVariable ( const char * name )

Removes a registered constant from the script mapping hash table.

Parameters

name	The name of the script entry to remove out of the const int hash. In case this string is equipped with a namespace, the string is in the form "namespace::variable". If you try to unregister a variable that was registered with a namespace, this namespace must be included in the given name, too.

See also: Com_RegisterConstInt; Com_GetConstVariable

Definition at line 147 of file scripts.cpp.

References Com_ConstIntGetVariable(), com_constNameInt, com_constNameInt_hash, Com_HashKey(), CONSTNAMEINT_HASH_SIZE, com_constNameInt_t::fullname, hash, com_constNameInt_t::hash_next, Mem_Free, name, com_constNameInt_t::next, and Q_streq.

Referenced by cgame_import_t::bool(), Com_UnregisterConstList(), GAME_GetImportData(), SV_InitGameProgs(), and TEST_F().

◆ Com_ValueToStr()

const char * Com_ValueToStr	(	const void *	base,
		const valueTypes_t	type,
		const int	ofs )

Parameters

[in]	base	The start pointer to a given data type (typedef, struct)
[in]	type	The data type that should be parsed
[in]	ofs	The offset for the value

See also: Com_SetValue

Returns: char pointer with translated data type value

Definition at line 1171 of file scripts.cpp.

References ALIGN_LAST, align_names, BLEND_LAST, blend_names, Com_AlignPtr(), Com_GetCrashedUfoIdStr(), Com_GetHumanCraftIdStr(), Com_GetUfoIdStr(), Com_Printf(), Com_sprintf(), csi, FADE_LAST, fade_names, MAX_DAMAGETYPES, MAX_VAR, Q_strncpyz(), STYLE_LAST, style_names, Sys_Backtrace(), Sys_Error(), TEAM_ALIEN, TEAM_CIVILIAN, TEAM_PHALANX, type, UFO_SIZE_T, V_AIRCRAFTTYPE, V_ALIGN, V_BLEND, V_BOOL, V_CHAR, V_COLOR, V_DAMAGE, V_FADE, V_FLOAT, V_HUNK_STRING, V_INT, V_INT2, V_LONGSTRING, V_NULL, V_POS, V_RELABS, V_SHAPE_BIG, V_SHAPE_SMALL, V_STRING, V_STYLE, V_TEAM, V_TRANSLATION_STRING, V_UFO, V_UFOCRASHED, V_VECTOR, and vt_aligns.

Referenced by Com_DropShipTypeToShortName(), Com_UFOCrashedTypeToShortName(), Com_UFOTypeToShortName(), GAME_GetImportData(), and UI_GetStringFromNodeProperty().

Variable Documentation

◆ align_names

const char* const align_names[]

extern

Definition at line 340 of file scripts.cpp.

Referenced by CASSERT(), Com_ParseValue(), and Com_ValueToStr().

◆ blend_names

const char* const blend_names[]

extern

Definition at line 345 of file scripts.cpp.

Referenced by CASSERT(), Com_ParseValue(), and Com_ValueToStr().

◆ fade_names

const char* const fade_names[]

extern

Definition at line 355 of file scripts.cpp.

Referenced by CASSERT(), Com_ParseValue(), and Com_ValueToStr().

◆ longlines_names

const char* const longlines_names[]

extern

◆ name_strings

const char* const name_strings[]

extern

Definition at line 2162 of file scripts.cpp.

Referenced by Com_FindNameType(), and Com_ParseActorSounds().

◆ style_names

const char* const style_names[]

extern

Definition at line 350 of file scripts.cpp.

Referenced by CASSERT(), Com_ParseValue(), and Com_ValueToStr().

◆ vt_names

const char* const vt_names[]

extern

possible values for parsing functions

See also: valueTypes_t

Definition at line 310 of file scripts.cpp.

Referenced by CASSERT(), CL_ParsePtlCmds(), and CL_ParticleFunction().

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ AIR_SLOT_TYPE_STRINGS

◆ AIRCRAFT_NONE

◆ MEMBER_SIZEOF

◆ SND_VOLUME_FOOTSTEPS

◆ UFO_MAX

◆ UFO_NONE

◆ V_BASETYPEMASK

Typedef Documentation

◆ ufoType_t

Enumeration Type Documentation

◆ align_t

◆ blend_t

◆ fade_t

◆ resultStatus_t

◆ style_t

◆ valueTypes_t

Function Documentation

◆ Com_AlignPtr()

◆ Com_DropShipShortNameToID()

◆ Com_DropShipTypeToShortName()

◆ Com_EParse()

◆ Com_EParseValue()

◆ Com_GetCharacterModel()

◆ Com_GetCharacterTemplateByID()

◆ Com_GetCharacterValues()

◆ Com_GetConstInt()

◆ Com_GetConstIntFromNamespace()

◆ Com_GetConstVariable()

◆ Com_GetDropShipIdsNum()

◆ Com_GetHumanAircraftIdsNum()

◆ Com_GetLastParseError()

◆ Com_GetRandomMapAssemblyNameForCraft()

◆ Com_GetRandomMapAssemblyNameForCrashedCraft()

◆ Com_GetScriptChecksum()

◆ Com_GetTeamDefinitionByID()

◆ Com_GetTerrainType()

◆ Com_GetUfoIdsNum()

◆ Com_GetUGVByID()

◆ Com_GetUGVByIDSilent()

◆ Com_GetValue() [1/2]

◆ Com_GetValue() [2/2]

◆ Com_ParseBlock()

◆ Com_ParseBlockToken()

◆ Com_ParseBoolean()

◆ Com_ParseList()

◆ Com_ParseScripts()

◆ Com_ParseValue()

◆ Com_RegisterConstInt()

◆ Com_RegisterConstList()

◆ Com_SetValue()

◆ Com_Shutdown()

◆ Com_UFOCrashedTypeToShortName()

◆ Com_UFOShortNameToID()

◆ Com_UFOTypeToShortName()

◆ Com_UnregisterConstList()

◆ Com_UnregisterConstVariable()

◆ Com_ValueToStr()

Variable Documentation

◆ align_names

◆ blend_names

◆ fade_names

◆ longlines_names

◆ name_strings

◆ style_names

◆ vt_names