IO.h

/*
 * Copyright (c) 2016-2024 Vera Visions LLC.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
 
class ncIO
{
public:
    void ncIO(void);
 
    virtual void Spawned(void);
 
    virtual void Respawn(void);
 
    virtual void ReloadCachedAttributes(void);
 
    virtual void SpawnKey(string,string);
 
    /* EntityDef interactions */
    nonvirtual float GetDefAct(string);
    nonvirtual string GetDefString(string);
    nonvirtual float GetDefFloat(string);
    nonvirtual bool GetDefBool(string);
    nonvirtual int GetDefInt(string);
    nonvirtual vector GetDefVector(string);
    nonvirtual ncSoundDict GetDefSound(string);
 
    nonvirtual float GetSubDefAct(string, string);
    nonvirtual string GetSubDefString(string, string);
    nonvirtual float GetSubDefFloat(string, string);
    nonvirtual bool GetSubDefBool(string, string);
    nonvirtual int GetSubDefInt(string, string);
    nonvirtual vector GetSubDefVector(string, string);
    nonvirtual ncSoundDict GetSubDefSound(string, string);
 
    nonvirtual void Destroy(void);
    virtual void OnRemoveEntity(void);
 
    nonvirtual void Relink(void);
 
    nonvirtual float GetNextThinkTime(void);
    nonvirtual bool IsThinking(void);
    nonvirtual void ReleaseThink(void);
    nonvirtual void ThinkBusy(float);
 
    nonvirtual void SetThink(void());
    nonvirtual void SetNextThink(float);
    nonvirtual void ScheduleThink(void(void),float);
 
#ifdef SERVER
    virtual void Save(float);
 
    virtual void Restore(string,string);
 
    virtual void RestoreComplete(void);
 
    virtual void TransitionComplete(void);
 
    virtual void Input(entity,string,string);
 
    /* helper functions to allocate outputs */
    nonvirtual void UseOutput(entity,string);
    nonvirtual string PrepareOutput(string,string);
 
    nonvirtual string CreateOutput(string);
 
    nonvirtual bool CheckOutput(string);
 
    virtual void ParentUpdate(void);
 
    /* save game related methods */
    nonvirtual void SaveFloat(float,string,float);
    nonvirtual void SaveInt(float,string,int);
    nonvirtual void SaveString(float,string,string);
    nonvirtual void SaveVector(float,string,vector);
    nonvirtual void SaveBool(float,string,bool);
    nonvirtual void SaveEntity(float,string,entity);
    nonvirtual void SetSendFlags(float);
#endif
 
#ifdef CLIENT
    virtual void _ReceiveComplete(float, float);
#endif
 
    nonvirtual float GetSpawnFloat(string);
    nonvirtual int GetSpawnInt(string);
    nonvirtual string GetSpawnString(string);
    nonvirtual vector GetSpawnVector(string);
    nonvirtual bool GetSpawnBool(string);
    nonvirtual entity GetSpawnEntity(string, entity);
    
    nonvirtual ncSoundDict GetSpawnSound(string keyName);
 
    /* load game/spawn helper functions */
    nonvirtual float ReadFloat(string);
    nonvirtual int ReadInt(string);
    nonvirtual string ReadString(string);
    nonvirtual vector ReadVector(string);
    nonvirtual bool ReadBool(string);
    nonvirtual entity ReadEntity(string);
 
    nonvirtual float GetTime(void);
 
    /* save game related methods */
    nonvirtual void DebugFloat(string,float);
    nonvirtual void DebugInt(string,int);
    nonvirtual void DebugString(string,string);
    nonvirtual void DebugVector(string,vector);
    nonvirtual void DebugBool(string,bool);
    nonvirtual void DebugEntity(string,entity);
 
private:
    string m_rawSpawnData;
#ifdef SERVER
    string m_outputOnSpawn;
    string m_outputOnKilled;
    string m_outputOnTrigger;
    string m_outputOnUser1;
    string m_outputOnUser2;
    string m_outputOnUser3;
    string m_outputOnUser4;
 
    /* entityDef powered modelevent callbacks */
    string m_modelEventCallbacks;
    string m_gameModeFilter;
#endif
};
 
#define CREATE_OUTPUT(x)    if (STRING_SET(x)) { \
        x = CreateOutput(x); \
    }
 
.bool _mapspawned;
 
#define CGENT_LOG           imageToConsole("gfx/icon16/brick", ICN_SIZE, "Client Entity Log")
#define CGENT_WARNING       imageToConsole("gfx/icon16/brick_error", ICN_SIZE, "Client Entity Warning")
#define CGENT_ERROR         imageToConsole("gfx/icon16/brick_delete", ICN_SIZE, "Client Entity Error")
 
#define SVENT_LOG           imageToConsole("gfx/icon16/brick", ICN_SIZE, "Server Entity Log")
#define SVENT_WARNING       imageToConsole("gfx/icon16/brick_error", ICN_SIZE, "Server Entity Warning")
#define SVENT_ERROR         imageToConsole("gfx/icon16/brick_delete", ICN_SIZE, "Server Entity Error")
 
void
_NSEntLog(string className, string functionName, float edictNum, string warnMessage)
{
#ifdef SERVER
    if (autocvar_g_logTimestamps)
        print(sprintf("%s ^9%f ^7%s (%d)^7: %s\n", SVENT_LOG, time, className, edictNum, warnMessage));
    else
        print(sprintf("%s ^7%s (%d)^7: %s\n", SVENT_LOG, className, edictNum, warnMessage));
#endif
#ifdef CLIENT
    if (autocvar_g_logTimestamps)
        print(sprintf("%s ^9%f ^7%s (%d)^7: %s\n", CGENT_LOG, time, className, edictNum, warnMessage));
    else
        print(sprintf("%s ^7%s (%d)^7: %s\n", CGENT_LOG, className, edictNum, warnMessage));
#endif
}
 
void
_NSEntWarning(string className, string functionName, float edictNum, string warnMessage)
{
#ifdef SERVER
    if (autocvar_g_logTimestamps)
        print(sprintf("%s ^9%f ^3%s (%d)^1: %s\n", SVENT_WARNING, time, functionName, edictNum, warnMessage));
    else
        print(sprintf("%s ^3%s (%d)^1: %s\n", SVENT_WARNING, functionName, edictNum, warnMessage));
#endif
#ifdef CLIENT
    if (autocvar_g_logTimestamps)
        print(sprintf("%s ^9%f ^3%s (%d)^1: %s\n", CGENT_WARNING, time, functionName, edictNum, warnMessage));
    else
        print(sprintf("%s ^3%s (%d)^1: %s\n", CGENT_WARNING, functionName, edictNum, warnMessage));
#endif
}
 
void
_NSEntError(string className, string functionName, float edictNum, string warnMessage)
{
#ifdef SERVER
    if (autocvar_g_logTimestamps)
        print(sprintf("%s ^9%f ^1%s (id: %d)^1: %s\n", SVENT_ERROR, time, functionName, edictNum, warnMessage));
    else
        print(sprintf("%s ^1%s (id: %d)^1: %s\n", SVENT_ERROR, functionName, edictNum, warnMessage));
#endif
#ifdef CLIENT
    if (autocvar_g_logTimestamps)
        print(sprintf("%s ^9%f ^1%s (id: %d)^1: %s\n", CGENT_ERROR, time, functionName, edictNum, warnMessage));
    else
        print(sprintf("%s ^1%s (id: %d)^1: %s\n", CGENT_ERROR, functionName, edictNum, warnMessage));
#endif
}
 
#define EntLog(...) if (autocvar_g_logLevel >= LOGLEVEL_DEBUG) _NSEntLog(classname, __FUNC__, num_for_edict(this), sprintf(__VA_ARGS__))
 
#define EntWarning(...) if (autocvar_g_logLevel >= LOGLEVEL_WARNINGS) _NSEntWarning(classname, __FUNC__, num_for_edict(this), sprintf(__VA_ARGS__))
 
#define EntError(...) if (autocvar_g_logLevel >= LOGLEVEL_ERRORS) _NSEntError(classname, __FUNC__, num_for_edict(this), sprintf(__VA_ARGS__))