NSEntity.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.
*/
 
typedef enumflags
{
    BASEFL_CHANGED_MODELINDEX,
    BASEFL_CHANGED_ORIGIN_X,
    BASEFL_CHANGED_ORIGIN_Y,
    BASEFL_CHANGED_ORIGIN_Z,
    BASEFL_CHANGED_ANGLES_X,
    BASEFL_CHANGED_ANGLES_Y,
    BASEFL_CHANGED_ANGLES_Z,
    BASEFL_CHANGED_VELOCITY_X,
    BASEFL_CHANGED_VELOCITY_Y,
    BASEFL_CHANGED_VELOCITY_Z,
    BASEFL_CHANGED_ANGULARVELOCITY,
    BASEFL_CHANGED_SIZE,
    BASEFL_CHANGED_FLAGS,
    BASEFL_CHANGED_SOLID,
    BASEFL_CHANGED_FRAME,
    BASEFL_CHANGED_SKIN,
    BASEFL_CHANGED_MOVETYPE,
    BASEFL_CHANGED_EFFECTS,
    BASEFL_CHANGED_SCALE,
} nsentity_changed_t;
 
class NSEntity:NSTrigger
{
public:
    void NSEntity(void);
 
#ifdef CLIENT
    virtual void ReceiveEntity(float,float);
 
    virtual void ReceiveEvent(float);
 
    virtual float predraw(void);
 
    virtual void postdraw(void);
 
    virtual void RendererRestarted(void);
#endif
 
    /* overrides */
    virtual void SpawnKey(string,string);
    virtual void Spawned(void);
    nonvirtual void Spawn(void);
 
    virtual void MakeStatic(void);
 
    virtual bool CanSpawn(bool clientSide);
 
    nonvirtual bool HasModel(void);
 
#ifdef SERVER
    virtual void Respawn(void);
    virtual void Input(entity,string,string);
    virtual void Save(float);
    virtual void Restore(string,string);
    virtual void ParentUpdate(void);
 
    nonvirtual void Event_SpawnDefRelative(string, float, float, float);
 
    /* Server-side rendering function. Expensive, but useful. */
    virtual void DebugDraw(void);
 
    virtual void EvaluateEntity(void);
 
    virtual float SendEntity(entity,float);
 
    nonvirtual entity GetParent(void);
 
    nonvirtual void SetParent(string);
 
    nonvirtual void SetParentAttachment(string);
 
    nonvirtual void ClearParent(void);
 
    nonvirtual void RestoreAngles(void);
 
    nonvirtual void ClearAngles(void);
 
    nonvirtual void UseBy(entity);
 
    nonvirtual void ForceNetworkUpdate(void);
#endif
 
    /* sets */
    nonvirtual void SetEffects(float);
    nonvirtual void AddEffects(effects_t);
    nonvirtual void RemoveEffects(effects_t);
    nonvirtual void SetFrame(float);
    nonvirtual void SetSkin(float);
    nonvirtual void SetScale(float);
    nonvirtual void SetOwner(entity);
    nonvirtual void SetVelocity(vector);
 
    nonvirtual void AddAngularVelocity(vector);
    nonvirtual void AddVelocity(vector);
 
    nonvirtual void SetTouch(void());
    nonvirtual void SetSendFlags(float);
    nonvirtual void SetSolid(float);
    virtual void SetModel(string);
    nonvirtual void SetModelindex(float);
    nonvirtual void SetMovetype(float);
    nonvirtual void SetGravity(float);
    nonvirtual void SetAngles(vector);
    nonvirtual void SetAngularVelocity(vector);
    nonvirtual void SetOrigin(vector);
    nonvirtual void SetOriginUnstick(vector);
    nonvirtual void SetSize(vector,vector);
    nonvirtual void AddFlags(float);
    nonvirtual void RemoveFlags(float);
    nonvirtual void AddVFlags(float);
    nonvirtual void RemoveVFlags(float);
 
    nonvirtual void TurnTo(float);
    nonvirtual void TurnToPos(vector);
 
    nonvirtual void SetThink(void());
    nonvirtual void SetNextThink(float);
    nonvirtual void ScheduleThink(void(void),float);
 
    /* gets */
    nonvirtual float GetEffects(void);
    nonvirtual float GetFrame(void);
    nonvirtual float GetSkin(void);
    nonvirtual float GetScale(void);
    nonvirtual entity GetOwner(void);
    nonvirtual vector GetVelocity(void);
    nonvirtual float GetSolid(void);
    nonvirtual string GetModel(void);
    nonvirtual float GetModelindex(void);
    nonvirtual float GetMovetype(void);
    nonvirtual float GetGravity(void);
    nonvirtual vector GetAngles(void);
    nonvirtual vector GetAngularVelocity(void);
    nonvirtual vector GetOrigin(void);
    nonvirtual vector GetSize(void);
    nonvirtual vector GetMins(void);
    nonvirtual vector GetMaxs(void);
    nonvirtual vector GetRealMins(void);
    nonvirtual vector GetRealMaxs(void);
    nonvirtual vector GetAbsoluteMins(void);
    nonvirtual vector GetAbsoluteMaxs(void);
    nonvirtual float GetFlags(void);
    nonvirtual float HasFlags(float);
    nonvirtual float GetVFlags(void);
    nonvirtual float HasVFlags(float);
    nonvirtual float GetNextThinkTime(void);
    nonvirtual bool IsThinking(void);
    nonvirtual void ReleaseThink(void);
    nonvirtual void ThinkBusy(float);
    nonvirtual void ClearVelocity(void);
 
    /* eye/shoot pos/angle */
    nonvirtual vector GetEyePos(void);
    nonvirtual void SetEyePos(vector);
    nonvirtual vector GetViewAngle(void);
 
    /* drawing related */
    nonvirtual void Show(void);
    nonvirtual void Hide(void);
    nonvirtual bool IsHidden(void);
    nonvirtual bool IsSolid(void);
 
    nonvirtual void Disappear(void);
    nonvirtual void UpdateBounds(void);
 
    /* useful methods, (some) based on GMod's API */
    nonvirtual float EntIndex(void);
    nonvirtual bool DropToFloor(void);
    nonvirtual vector GetForward(void);
    nonvirtual vector GetRight(void);
    nonvirtual vector GetUp(void);
    nonvirtual vector WorldSpaceCenter(void);
    nonvirtual float WaterLevel(void);
 
    nonvirtual bool Visible(entity);
    nonvirtual bool VisibleVec(vector);
    nonvirtual float DistanceFromYaw(vector);
    nonvirtual bool HasSpawnFlags(float);
    nonvirtual bool IsOnGround(void);
    nonvirtual entity GetGroundEntity(void);
    nonvirtual bool CreatedByMap(void);
    nonvirtual bool WithinBounds(entity);
    nonvirtual bool IntersectsWith(entity);
 
    /* useful methods, (some) based on Doom 3's API */
    nonvirtual bool StartSound(string,float,float,bool);
    nonvirtual bool StartSoundDef(string,float,bool);
    nonvirtual void StopSound(float,bool);
 
    nonvirtual vector NearestWallPointForRadius(float);
 
    nonvirtual void HandleThink(void);
 
    nonvirtual bool IsFacing(entity);
 
    nonvirtual bool IsFacingPosition(vector);
 
    nonvirtual float GetSpawnAge(void);
 
    nonvirtual float GetSpawnTime(void);
    nonvirtual void Transport(vector, vector);
 
    nonvirtual void Relink(void);
 
    nonvirtual vector GetNearbySpot(void);
 
    nonvirtual int GetSharedID(void);
 
    virtual bool AttackByDef(string, bool);
 
    nonvirtual void SetBotTag(botInfo_t);
 
    nonvirtual void EnablePlayerCollision(void);
    nonvirtual void DisablePlayerCollision(void);
    nonvirtual bool HeldByPlayer(void);
    nonvirtual bool IsBrush(void);
 
private:
    float m_flSpawnTime;
    bool m_bHidden; 
    vector m_vecMins; 
    vector m_vecMaxs; 
    bool m_bIsBrush;
    vector m_vecEditorColor;
 
    NETWORKED_INT(entityDefID)
    NETWORKED_VECTOR_N(origin)
    NETWORKED_VECTOR_N(angles)
    NETWORKED_FLOAT_N(modelindex)
    NETWORKED_VECTOR_N(size)
    NETWORKED_VECTOR_N(mins)
    NETWORKED_VECTOR_N(maxs)
    NETWORKED_FLOAT_N(solid)
    NETWORKED_FLOAT_N(movetype)
    NETWORKED_FLOAT_N(scale)
    NETWORKED_FLOAT_N(flags)
    NETWORKED_FLOAT_N(vv_flags)
    NETWORKED_VECTOR_N(velocity)
    NETWORKED_VECTOR_N(avelocity)
 
#ifdef CLIENT
    virtual void _ReceiveComplete(float, float);
#endif
 
    entity m_holdingPlayer;
    float m_lastHeldTime;
 
#ifdef SERVER
    string m_parent;
    string m_parent_old;
    string m_parent_attachment;
    NETWORKED_FLOAT_N(frame)
    NETWORKED_FLOAT_N(skin)
    NETWORKED_FLOAT_N(effects)
    vector m_vecModelMins;
    vector m_vecModelMaxs;
    nonvirtual vector GetModelMins(void);
    nonvirtual vector GetModelMaxs(void);
#endif
    nonvirtual bool _ProjectileAttack(string, bool);
};
 
NSEntity spawnClass(string className, vector desiredPos);
 
#ifdef SERVER
bool changeClass(entity target, string className)
#endif
 
void sendInput(entity target, string inputName, string dataString, entity activator);
 
bool isAI(entity entityToCheck);
 
bool isAlive(entity entityToCheck);
 
bool isGodMode(entity entityToCheck);
 
bool isClient(entity entityToCheck);
 
bool isPlayer(entity entityToCheck);
 
bool isSentient(entity entityToCheck);
 
bool isBot(entity entityToCheck);
 
bool isItem(entity entityToCheck);
 
bool isWeapon(entity entityToCheck);