scripts.h

Go to the documentation of this file.

/*
Copyright (C) 2002-2010 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.

*/

#ifndef SCRIPTS_H
#define SCRIPTS_H

#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 = 5,
    V_POS,
    V_VECTOR,
    V_COLOR,
    V_RGBA,
    V_STRING = 10,
    V_TRANSLATION_STRING,   
    V_LONGSTRING,           
    V_ALIGN,
    V_BLEND,
    V_STYLE = 15,
    V_FADE,
    V_SHAPE_SMALL,          
    V_SHAPE_BIG,            
    V_DMGTYPE,
    V_DMGWEIGHT = 20,
    V_DATE,
    V_RELABS,               
    V_CLIENT_HUNK,          
    V_CLIENT_HUNK_STRING,   
    V_TEAM,                 
    V_RACE,
    V_UFO,                  
    V_UFOCRASHED,
    V_AIRCRAFTTYPE,

    V_NUM_TYPES
} 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 enum {
    UFO_SCOUT,
    UFO_FIGHTER,
    UFO_HARVESTER,
    UFO_CORRUPTER,
    UFO_BOMBER,
    UFO_CARRIER,
    UFO_SUPPLY,
    UFO_GUNBOAT,
    UFO_RIPPER,
    UFO_MOTHERSHIP,

    UFO_MAX
} ufoType_t;

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[];
extern const char *const air_slot_type_strings[];

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

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

#ifdef DEBUG
int Com_EParseValueDebug(void *base, const char *token, valueTypes_t type, int ofs, size_t size, const char* file, int line);
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__)
#define Com_EParseValue(base, token, type, ofs, size) Com_EParseValueDebug(base, token, type, ofs, size, __FILE__, __LINE__)
#else
int Com_EParseValue(void *base, const char *token, valueTypes_t type, int ofs, size_t size);
int Com_SetValue(void *base, const void *set, valueTypes_t type, int ofs, size_t size);
#endif
void* Com_AlignPtr(void *memory, valueTypes_t type);
const char *Com_ValueToStr(const void *base, const valueTypes_t type, const int ofs);
const char *Com_GetLastParseError(void);
int Com_ParseValue(void *base, const char *token, valueTypes_t type, int ofs, size_t size, size_t *writtenBytes);
qboolean Com_ParseBoolean(const char *token);

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

extern const char *const name_strings[];

#define SND_VOLUME_FOOTSTEPS 0.2f

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 {
    char *name;
    int value;
} constListEntry_t;

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

void Com_ParseScripts(qboolean onlyServer);
const char *Com_EParse(const char **text, const char *errhead, const char *errinfo);
const char *Com_GetRandomMapAssemblyNameForCraft(const char *craftID);
ufoType_t Com_UFOShortNameToID(const char *token);
const char* Com_UFOTypeToShortName(ufoType_t type);
const char* Com_UFOCrashedTypeToShortName(ufoType_t type);
int Com_GetScriptChecksum(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);
const char* Com_GetActorSound(teamDef_t* td, int gender, actorSound_t soundType);
teamDef_t* Com_GetTeamDefinitionByID(const char *team);
const chrTemplate_t* Com_GetCharacterTemplateByID(const char *chrTemplate);

#endif /* SCRIPTS_H */