engine_ttdef.h

/*  Renegade Scripts.dll
    Copyright 2013 Tiberian Technologies
 
    This file is part of the Renegade scripts.dll
    The Renegade scripts.dll 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, or (at your option) any later
    version. See the file COPYING for more details.
    In addition, an exemption is given to allow Run Time Dynamic Linking of this code with any closed source module that does not contain code covered by this licence.
    Only the source code to the module(s) containing the licenced code has to be released.
*/
#ifndef SCRIPTS_INCLUDE__ENGINE_TTDEF_H
#define SCRIPTS_INCLUDE__ENGINE_TTDEF_H
#include "scripts.h"
 
class BaseControllerClass;
class PhysicalGameObj;
class AmmoDefinitionClass;
 
enum TextMessageEnum
{
    TEXT_MESSAGE_PUBLIC,
    TEXT_MESSAGE_TEAM,
    TEXT_MESSAGE_PRIVATE,
    TEXT_MESSAGE_TMSG, //special extra value for the TMSG console command
};
enum AnnouncementEnum
{
    ANNOUNCE_PUBLIC,
    ANNOUNCE_TEAM,
    ANNOUNCE_PRIVATE,
};
enum PurchaseStatus
{
    PurchaseStatus_AllowNoSpawn = -3, // Purchase is allowed as normal, without spawning the vehicle. (only for VehiclePurchaseHook)
    PurchaseStatus_AllowFree = -2, // Purchase is allowed as normal, without charging the player.
    PurchaseStatus_Allow = -1, // Purchase is allowed as normal.
    PurchaseStatus_Granted, // "Purchase request granted."
    PurchaseStatus_Pending, // "Transaction pending."
    PurchaseStatus_InsufficientFunds, // "You have insufficient funds for this purchase."
    PurchaseStatus_FactoryUnavailable, // "The factory is not presently available."
    PurchaseStatus_OutOfStock, // "This item is not presently in stock."
};
enum DialogMessageType
{
    MESSAGE_TYPE_DIALOG_SHOW, // gets called when the dialog is shown
    MESSAGE_TYPE_DIALOG_CLOSE, // gets called when the dialog is hidden/being deleted
    MESSAGE_TYPE_DIALOG_ESCAPE, // gets called when the client hits Esc key
    MESSAGE_TYPE_CONTROL_MOUSE_CLICK, // gets called when the client left-clicks on a supported control
    MESSAGE_TYPE_CONTROL_VALUE_CHANGE, // gets called when the client changes the value of a supported control
    MESSAGE_TYPE_CONTROL_VALUE_CONFIRM, // gets called when the client hits Enter key on a supported control
    MESSAGE_TYPE_CONTROL_FOCUSED // gets called when the client changes the focused control
};
typedef bool (*ChatHook) (int PlayerID,TextMessageEnum Type,const wchar_t *Message,int recieverID);
typedef bool (*HostHook) (int PlayerID,TextMessageEnum Type,const char *Message);
typedef void (*ObjectCreateHook) (void *data,GameObject *obj);
typedef void (*PlayerJoin) (int PlayerID,const char *PlayerName);
typedef void (*PlayerLeave) (int PlayerID);
typedef void (*LoadLevelHook) ();
typedef void (*ConsoleOutputHook) (const char *output);
typedef PurchaseStatus (*PurchaseHook) (BaseControllerClass *base,GameObject *purchaser,unsigned int cost,unsigned int preset,const char *data);
typedef void (*PurchaseMonHook) (BaseControllerClass *base,GameObject *purchaser,unsigned int cost,unsigned int preset,unsigned int purchaseret,const char *data);
typedef bool (*RefillHook) (GameObject *purchaser);
typedef bool (*RadioHook) (int PlayerType, int PlayerID, int AnnouncementID, int IconID, AnnouncementEnum AnnouncementType);
typedef bool (*StockDamageHook) (PhysicalGameObj* damager, PhysicalGameObj* target, float damage, uint warheadId);
typedef bool (*TtDamageHook) (PhysicalGameObj* damager, PhysicalGameObj* target, const AmmoDefinitionClass* ammo, const char* bone);
typedef void (*DialogHook) (int PlayerID, int DialogID, int ControlID, DialogMessageType MessageType);
 
struct ObjectCreateHookStruct {
    ObjectCreateHook hook;
    void *data;
};
 
typedef void (*KeyHook) (void *data);
struct KeyHookStruct {
    KeyHook hook;
    const char *key;
    int PlayerID;
    void *data;
};
 
typedef void (*ShaderNotify) (void *data, int notify);
struct ShaderNotifyStruct {
    ShaderNotify hook;
    int ID;
    int PlayerID;
    void *data;
};
 
//values for Set_Fog_Mode and Set_Fog_Mode_Player
#define FOG_EXP 1 //Set_Fog_Density applies to this mode
#define FOG_EXP2 2 //Set_Fog_Density applies to this mode
#define FOG_LINEAR 3 //This is the default if you are using fog
 
enum PathfindDistanceResult
{
    PATHFIND_DISTANCE_INVALID_RESULT = -1,
    PATHFIND_DISTANCE_RESULT_OK = 0,
    PATHFIND_DISTANCE_RESULT_CANCELED,
    PATHFIND_DISTANCE_RESULT_INVALID_START_POS,
    PATHFIND_DISTANCE_RESULT_INVALID_DEST_POS,
    PATHFIND_DISTANCE_RESULT_NO_PATH,
    PATHFIND_DISTANCE_RESULT_COUNT
};
 
struct PathfindDistanceRequest;
 
typedef void(*PathfindDistanceCallback)(const PathfindDistanceRequest &result);
class PathSolveClass;
struct PathfindDistanceRequest
{
    PathfindDistanceRequest() :
        Id(0), Start(), Dest(), PathSolver(nullptr), Result(PATHFIND_DISTANCE_INVALID_RESULT), Distance(0.0f), Callback(nullptr), Data(nullptr)
    {
 
    }
 
    PathfindDistanceRequest(uint32 id, const Vector3 &start, const Vector3 &dest, PathSolveClass* solver, PathfindDistanceCallback callback, void *data) :
        Id(id), Start(start), Dest(dest), PathSolver(solver), Result(PATHFIND_DISTANCE_INVALID_RESULT), Distance(0.0f), Callback(callback), Data(data)
    {
 
    }
 
    bool operator==(const PathfindDistanceRequest &other) const
    {
        return false;
    }
 
    bool operator!=(const PathfindDistanceRequest &other) const
    {
        return true;
    }
 
    void Do_Callback()
    {
        Callback((*this));
    }
 
    uint32 Id;
    Vector3 Start;
    Vector3 Dest;
    PathSolveClass *PathSolver;
    PathfindDistanceResult Result;
    float Distance;
    PathfindDistanceCallback Callback;
    void *Data;
};
 
#endif