scripts.h

Go to the documentation of this file.

/*
Copyright (C) 2002-2022 UFO: Alien Invasion.

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

*/

#pragma once

#include "common.h"

#ifndef ALIGN_PTR
#define ALIGN_PTR(value,size) (void*)(((uintptr_t)value + (size - 1)) & (~(size - 1)))
#endif

#define MEMBER_SIZEOF(TYPE, MEMBER) sizeof(((TYPE*)0)->MEMBER)

#define V_BASETYPEMASK 0x3F

typedef enum {
    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
} valueTypes_t;

extern const char* const vt_names[];

typedef enum {
    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
} align_t;

typedef enum {
    BLEND_REPLACE,
    BLEND_ONE,
    BLEND_BLEND,
    BLEND_ADD,
    BLEND_FILTER,
    BLEND_INVFILTER,

    BLEND_LAST
} blend_t;

typedef enum {
    STYLE_FACING,   
    STYLE_ROTATED,  
    STYLE_BEAM,
    STYLE_LINE,
    STYLE_AXIS,
    STYLE_CIRCLE,

    STYLE_LAST
} style_t;

typedef enum {
    FADE_NONE,
    FADE_IN,
    FADE_OUT,
    FADE_SIN,
    FADE_SAW,

    FADE_LAST
} fade_t;

typedef short ufoType_t;
#define UFO_MAX 16
#define AIRCRAFT_NONE -1
#define UFO_NONE AIRCRAFT_NONE
extern const char* const align_names[];
extern const char* const blend_names[];
extern const char* const style_names[];
extern const char* const fade_names[];
extern const char* const longlines_names[];
#define AIR_SLOT_TYPE_STRINGS { \
"base_missile", \
"base_laser", \
"weapon", \
"shield", \
"electronics", \
"pilot", \
"ammo", \
"base_ammo_missile", \
"base_ammo_laser" \
}

typedef struct value_s {
    const char* string;
    valueTypes_t type;
    size_t ofs;
    size_t size;
} value_t;

template<typename T> inline T& Com_GetValue(void* const object, value_t const* const value)
{
    return *reinterpret_cast<T*>(reinterpret_cast<byte*>(object) + value->ofs);
}

template<typename T> inline T const& Com_GetValue(void const* const object, value_t const* const value)
{
    return Com_GetValue<T>(const_cast<void*>(object), value);
}

typedef enum {
    RESULT_ERROR = -1,
    RESULT_WARNING = -2,
    RESULT_OK = 0
} resultStatus_t;

#ifdef DEBUG
int Com_SetValueDebug(void* base, const void* set, valueTypes_t type, int ofs, size_t size, const char* file, int line);
#define Com_SetValue(base, set, type, ofs, size) Com_SetValueDebug(base, set, type, ofs, size, __FILE__, __LINE__)
#else
int Com_SetValue(void* base, const void* set, valueTypes_t type, int ofs, size_t size);
#endif
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);
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);
bool Com_ParseBoolean(const char* token);

/*==============================================================
SCRIPT PARSING
==============================================================*/

extern const char* const name_strings[];

#define SND_VOLUME_FOOTSTEPS 0.4f

typedef struct terrainType_s {
    const char* texture;            
    const char* footstepSound;      
    const char* particle;           
    float bounceFraction;           
    float footstepVolume;           
    struct terrainType_s* hash_next;    
} terrainType_t;

const terrainType_t* Com_GetTerrainType(const char* textureName);

typedef struct constListEntry_s {
    const char* name;
    int value;
} constListEntry_t;

bool Com_GetConstInt(const char* name, int* value);
bool Com_GetConstIntFromNamespace(const char* space, const char* variable, int* value);
const char* Com_GetConstVariable(const char* space, int value);
bool Com_UnregisterConstVariable(const char* name);
void Com_RegisterConstInt(const char* name, int value);
void Com_RegisterConstList(const constListEntry_t constList[]);
bool Com_UnregisterConstList(const constListEntry_t constList[]);

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);
const char* Com_GetRandomMapAssemblyNameForCraft(const char* craftID);
const char* Com_GetRandomMapAssemblyNameForCrashedCraft(const char* craftID);
ufoType_t Com_UFOShortNameToID(const char* token);
const char* Com_UFOTypeToShortName(ufoType_t type);
const char* Com_UFOCrashedTypeToShortName(ufoType_t type);
short Com_GetUfoIdsNum(void);
short Com_GetDropShipIdsNum(void);
short Com_GetHumanAircraftIdsNum(void);
int Com_GetScriptChecksum(void);
void Com_Shutdown(void);

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

const ugv_t* Com_GetUGVByIDSilent(const char* ugvID);
const ugv_t* Com_GetUGVByID(const char* ugvID);
const char* Com_DropShipTypeToShortName(humanAircraftType_t type);
humanAircraftType_t Com_DropShipShortNameToID(const char* token);
void Com_GetCharacterValues(const char* teamDefition, character_t* chr);
bool Com_GetCharacterModel(character_t* chr);
const teamDef_t* Com_GetTeamDefinitionByID(const char* team);
const chrTemplate_t* Com_GetCharacterTemplateByID(const char* chrTemplate);