cgame.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 CL_CGAME_H
#define CL_CGAME_H

#include "mxml/mxml.h"

typedef struct {
    const char *name;
    const char *menu;
    int gametype;
    void (EXPORT *Init) (void);
    void (EXPORT *Shutdown) (void);
    qboolean (EXPORT *Spawn) (void);
    int (EXPORT *GetTeam) (void);
    const mapDef_t* (EXPORT *MapInfo) (int step);
    void (EXPORT *Results) (struct dbuffer *msg, int, int*, int*, int[][MAX_TEAMS], int[][MAX_TEAMS]);
    qboolean (EXPORT *IsItemUseable) (const objDef_t *od);
    void (EXPORT *DisplayItemInfo) (uiNode_t *node, const char *string);
    equipDef_t* (EXPORT *GetEquipmentDefinition) (void);
    void (EXPORT *UpdateCharacterValues) (const character_t *chr);
    qboolean (EXPORT *IsTeamKnown) (const teamDef_t *teamDef);
    void (EXPORT *Drop) (void);
    void (EXPORT *InitializeBattlescape) (const chrList_t *team);
    void (EXPORT *RunFrame) (void);
    const char* (EXPORT *GetModelForItem) (const objDef_t*od);
    void (EXPORT *EndRoundAnnounce) (int playerNum, int team);
    void (EXPORT *StartBattlescape) (qboolean isTeamPlay);
} cgame_export_t;

typedef struct {
    csi_t *csi;
    client_static_t *cls;
    client_state_t *cl;

    /* menu functions */
    void (IMPORT *UI_ExecuteConfunc) (const char *fmt, ...) __attribute__((format(printf, 1, 2)));
    void (IMPORT *UI_PopWindow) (qboolean all);
    uiNode_t* (IMPORT *UI_PushWindow) (const char *name, const char *parentName);
    void (IMPORT *UI_InitStack) (const char* activeMenu, const char* mainMenu, qboolean popAll, qboolean pushActive);
    void (IMPORT *UI_Popup) (const char *title, const char *text);
    uiNode_t* (IMPORT *UI_AddOption) (uiNode_t** tree, const char* name, const char* label, const char* value);
    void (IMPORT *UI_RegisterOption) (int dataId, uiNode_t *option);
    void (IMPORT *UI_RegisterText) (int textId, const char *text);
    void (IMPORT *UI_ResetData) (int dataId);
    void (IMPORT *UI_RegisterLinkedListText) (int textId, linkedList_t *text);
    void (IMPORT *UI_TextNodeSelectLine) (uiNode_t *node, int num);
    uiNode_t *(IMPORT *UI_PopupList) (const char *title, const char *headline, linkedList_t* entries, const char *clickAction);

    /* xml functions */
    mxml_node_t * (IMPORT *mxml_AddNode) (mxml_node_t *parent, const char *name);
    void (IMPORT *mxml_AddString) (mxml_node_t *parent, const char *name, const char *value);
    void (IMPORT *mxml_AddBool) (mxml_node_t *parent, const char *name, qboolean value);
    void (IMPORT *mxml_AddFloat) (mxml_node_t *parent, const char *name, float value);
    void (IMPORT *mxml_AddDouble) (mxml_node_t *parent, const char *name, double value);
    void (IMPORT *mxml_AddByte) (mxml_node_t *parent, const char *name, byte value);
    void (IMPORT *mxml_AddShort) (mxml_node_t *parent, const char *name, short value);
    void (IMPORT *mxml_AddInt) (mxml_node_t *parent, const char *name, int value);
    void (IMPORT *mxml_AddLong) (mxml_node_t *parent, const char *name, long value);
    void (IMPORT *mxml_AddPos3) (mxml_node_t *parent, const char *name, const vec3_t pos);
    void (IMPORT *mxml_AddPos2) (mxml_node_t *parent, const char *name, const vec2_t pos);
    void (IMPORT *mxml_AddDate) (mxml_node_t *parent, const char *name, const int day, const int sec);
    void (IMPORT *mxml_AddStringValue) (mxml_node_t *parent, const char *name, const char *value);
    void (IMPORT *mxml_AddBoolValue) (mxml_node_t *parent, const char *name, qboolean value);
    void (IMPORT *mxml_AddFloatValue) (mxml_node_t *parent, const char *name, float value);
    void (IMPORT *mxml_AddDoubleValue) (mxml_node_t *parent, const char *name, double value);
    void (IMPORT *mxml_AddByteValue) (mxml_node_t *parent, const char *name, byte value);
    void (IMPORT *mxml_AddShortValue) (mxml_node_t *parent, const char *name, short value);
    void (IMPORT *mxml_AddIntValue) (mxml_node_t *parent, const char *name, int value);
    void (IMPORT *mxml_AddLongValue) (mxml_node_t *parent, const char *name, long value);

    /* filesystem functions */
    int (IMPORT *FS_LoadFile) (const char *path, byte **buffer);
    void (IMPORT *FS_FreeFile) (void *buffer);

    /* console variable interaction */
    cvar_t *(IMPORT *Cvar_Get) (const char *varName, const char *value, int flags, const char* desc);
    cvar_t *(IMPORT *Cvar_Set) (const char *varName, const char *value);
    void (IMPORT *Cvar_SetValue) (const char *varName, float value);
    const char *(IMPORT *Cvar_String) (const char *varName);
    int (IMPORT *Cvar_Integer) (const char *varName);
    qboolean (IMPORT *Cvar_Delete) (const char *varName);

    /* sound functions */
    void (IMPORT *S_StartLocalSample) (const char *s, float volume);
    void (IMPORT *S_SetSampleRepeatRate) (int sampleRepeatRate);

    /* renderer functions */
    void (IMPORT *R_SoftenTexture) (byte *in, int width, int height, int bpp);
    void (IMPORT *R_UploadAlpha) (const image_t *image, const byte *alphaData);
    void (IMPORT *R_LoadImage) (const char *name, byte **pic, int *width, int *height);
    image_t *(IMPORT *R_LoadImageData) (const char *name, byte * pic, int width, int height, imagetype_t type);

    /* ClientCommand and ServerCommand parameter access */
    int (IMPORT *Cmd_Argc) (void);
    const char *(IMPORT *Cmd_Argv) (int n);
    const char *(IMPORT *Cmd_Args) (void);      
    void (IMPORT *Cmd_AddCommand) (const char *cmdName, xcommand_t function, const char *desc);
    void (IMPORT *Cmd_RemoveCommand) (const char *cmdName);
    void (IMPORT *Cmd_ExecuteString) (const char *text);
} cgame_import_t;

cgame_export_t *GetCGameAPI(cgame_import_t *import);

#endif