Nuclide
Software Development Kit for id Tech
NSPhysicsEntity.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2016-2022 Vera Visions LLC.
3 *
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
7 *
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
13 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
14 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15*/
16
17var bool autocvar_phys_developer = false;
18void
19_NSPhysics_Log(string msg)
20{
21 if (autocvar_phys_developer == true)
22 print(sprintf("%f %s\n", time, msg));
23}
24#define NSPhysics_Log(...) _NSPhysics_Log(sprintf(__VA_ARGS__))
25
26
27var float autocvar_phys_pushscale = 1.0f;
29
30#ifdef CLIENT
32#endif
33
37
38enum
39{
45};
46
48{
49 BPHY_NODMGPUSH,
50 BPHY_SHARP
51};
52
53
54typedef enumflags
55{
56 PHYENT_CHANGED_ORIGIN_X,
57 PHYENT_CHANGED_ORIGIN_Y,
58 PHYENT_CHANGED_ORIGIN_Z,
59 PHYENT_CHANGED_ANGLES_X,
60 PHYENT_CHANGED_ANGLES_Y,
61 PHYENT_CHANGED_ANGLES_Z,
62 PHYENT_CHANGED_MODELINDEX,
63 PHYENT_CHANGED_SIZE,
64 PHYENT_CHANGED_FLAGS,
65 PHYENT_CHANGED_SOLID,
66 PHYENT_CHANGED_FRAME,
67 PHYENT_CHANGED_SKIN,
68 PHYENT_CHANGED_MOVETYPE,
69 PHYENT_CHANGED_EFFECTS,
70 PHYENT_CHANGED_BODY,
71 PHYENT_CHANGED_SCALE,
72 PHYENT_CHANGED_VELOCITY,
73 PHYENT_CHANGED_RENDERCOLOR,
74 PHYENT_CHANGED_RENDERAMT,
75 PHYENT_CHANGED_RENDERMODE,
76} nsphyricsentity_changed_t;
77
89{
90public:
91 void NSPhysicsEntity(void);
92
93 /* overrides */
94 virtual void Respawn(void);
95 virtual void SpawnKey(string,string);
96#ifdef SERVER
97 virtual void Spawned(void);
98 virtual void Pain(entity, entity, int, vector, int);
99 virtual void Death(entity, entity, int, vector, int);
100 virtual void EvaluateEntity(void);
101 virtual float SendEntity(entity,float);
102 virtual void Save(float);
103 virtual void Restore(string,string);
104 virtual void Touch(entity);
105#endif
106#ifdef CLIENT
107 virtual void ReceiveEntity(float,float);
108 virtual void postdraw(void);
109#endif
110
111 nonvirtual void _UpdateBuoyancy(void);
112 nonvirtual void _UpdateMass(void);
113
115 nonvirtual void SetFriction(float);
117 nonvirtual float GetFriction(void);
118
120 nonvirtual float CalculateImpactDamage(int,int);
121
122 /* this merely mirrors the GMod API: https://wiki.facepunch.com/gmod/PhysObj */
123
125 nonvirtual vector AlignAngles(vector, vector);
127 nonvirtual void ApplyForceCenter(vector);
129 nonvirtual void ApplyForceOffset(vector,vector);
131 nonvirtual void ApplyTorqueCenter(vector);
133 nonvirtual void EnableDrag(bool);
135 nonvirtual void EnableGravity(bool);
137 nonvirtual void EnableMotion(bool);
139 nonvirtual float GetLinearDamping(void);
141 nonvirtual float GetAngularDamping(void);
143 nonvirtual float GetEnergy(void);
145 nonvirtual float GetInertia(void);
147 nonvirtual float GetInvInertia(void);
149 nonvirtual float GetInvMass(void);
151 nonvirtual float GetMass(void);
153 nonvirtual vector GetMassCenter(void);
155 nonvirtual float GetRotDamping(void);
157 nonvirtual float GetSpeedDamping(void);
159 nonvirtual float GetSurfaceArea(void);
161 nonvirtual float GetVolume(void);
163 nonvirtual bool IsAsleep(void);
165 nonvirtual bool IsCollisionEnabled(void);
167 nonvirtual bool IsDragEnabled(void);
169 nonvirtual bool IsGravityEnabled(void);
171 nonvirtual bool IsMotionEnabled(void);
173 nonvirtual bool IsMoveable(void);
175 nonvirtual bool IsPenetrating(void);
176
178 nonvirtual void SetAngleDragCoefficient(float);
180 nonvirtual void SetBuoyancyRatio(float);
182 nonvirtual void SetDamping(float, float);
184 nonvirtual void SetDragCoefficient(float);
185
187 nonvirtual void SetInertia(float);
189 nonvirtual void SetMass(float);
190
192 nonvirtual void Wake(void);
194 nonvirtual void Sleep(void);
195
196private:
197 int m_iEnabled;
198 int m_iShape;
199 int m_iMaterial;
200 int m_iFlags;
201 float m_flInertiaScale;
202 float m_flBuoyancyRatio;
203 bool m_bInvincible;
204 float m_flVolume;
205
206 /* performance sanity checks */
207 vector m_vecPrevOrigin;
208 vector m_vecPrevAngles;
209 float m_flCheckTime;
210 PREDICTED_FLOAT(m_flMass)
211
212 virtual void _TouchThink(void);
213
214#ifdef SERVER
215 PREDICTED_VECTOR(m_vecNetAngles)
216
217 string m_strOnDamaged;
218#endif
219};
220
221noref .bool isPhysics;
@ PHYSM_BOX
Definition: NSPhysicsEntity.h:40
@ PHYSM_SPHERE
Definition: NSPhysicsEntity.h:41
@ PHYSM_CYLINDER
Definition: NSPhysicsEntity.h:44
@ PHYSM_TRIMESH
Definition: NSPhysicsEntity.h:43
@ PHYSM_CAPSULE
Definition: NSPhysicsEntity.h:42
var float autocvar_phys_impactforcescale
Definition: NSPhysicsEntity.h:28
var bool autocvar_r_showPhysicsInfo
Definition: NSPhysicsEntity.h:31
var bool autocvar_phys_developer
Definition: NSPhysicsEntity.h:17
void _NSPhysics_Log(string msg)
Definition: NSPhysicsEntity.h:19
float damp_angular
Definition: NSPhysicsEntity.h:35
float damp_linear
Definition: NSPhysicsEntity.h:34
var float autocvar_phys_pushscale
Definition: NSPhysicsEntity.h:27
float jointgroup
Definition: NSPhysicsEntity.h:36
noref bool isPhysics
Definition: NSPhysicsEntity.h:221
enumflags
Definition: NSPhysicsEntity.h:48
This entity class represents physically-simulated entities.
Definition: NSPhysicsEntity.h:89
virtual float SendEntity(entity, float)
Called by the engine whenever we need to send a client an update about this entity.
Definition: NSPhysicsEntity.qc:191
virtual void Touch(entity)
Called whenever we're touching another entity.
Definition: NSPhysicsEntity.qc:421
nonvirtual bool IsDragEnabled(void)
Returns whether the entity is affected by drag.
Definition: NSPhysicsEntity.qc:867
nonvirtual float GetVolume(void)
Returns the volume of the entity.
Definition: NSPhysicsEntity.qc:849
nonvirtual vector AlignAngles(vector, vector)
Call to align angles of the object to the ones passed.
Definition: NSPhysicsEntity.qc:681
nonvirtual float GetRotDamping(void)
Returns the rotational damping of the entity.
Definition: NSPhysicsEntity.qc:831
nonvirtual void SetFriction(float)
Sets the friction multiplier for this entity.
Definition: NSPhysicsEntity.qc:375
nonvirtual bool IsPenetrating(void)
Returns whether the entity is penetrating another object.
Definition: NSPhysicsEntity.qc:891
nonvirtual bool IsGravityEnabled(void)
Returns whether the entity is affected by gravity.
Definition: NSPhysicsEntity.qc:873
nonvirtual void ApplyTorqueCenter(vector)
Call to apply torque (angular velocity vector) to the center of the entity.
Definition: NSPhysicsEntity.qc:734
virtual void postdraw(void)
Client: Run after the rendering of 3D world is complete.
nonvirtual float GetInertia(void)
Returns the inertia modifier of this entity.
Definition: NSPhysicsEntity.qc:801
nonvirtual bool IsMoveable(void)
Returns whether the entity is able to move.
Definition: NSPhysicsEntity.qc:885
nonvirtual float GetInvInertia(void)
Returns 1 divided by the angular inertia of this entity.
Definition: NSPhysicsEntity.qc:807
nonvirtual float GetSurfaceArea(void)
Returns the surface area of the entity.
Definition: NSPhysicsEntity.qc:843
nonvirtual float GetMass(void)
Returns the mass of the entity.
Definition: NSPhysicsEntity.qc:819
nonvirtual bool IsMotionEnabled(void)
Returns whether the entity is able to move by itself.
Definition: NSPhysicsEntity.qc:879
virtual void ReceiveEntity(float, float)
Client: Handles network updates from the server for the associated entity.
nonvirtual float GetEnergy(void)
Returns the linear and rotational kinetic energy combined.
Definition: NSPhysicsEntity.qc:786
nonvirtual void SetAngleDragCoefficient(float)
Call to set the amount of rotational drag the entity experiences.
Definition: NSPhysicsEntity.qc:897
nonvirtual float GetSpeedDamping(void)
Returns the speed damping of the entity.
Definition: NSPhysicsEntity.qc:837
nonvirtual void EnableGravity(bool)
Call to set whether the entity should be affected by gravity.
Definition: NSPhysicsEntity.qc:761
virtual void Respawn(void)
Server: Called when the entity first spawns or when game-logic requests the entity to return to its o...
Definition: NSPhysicsEntity.qc:565
nonvirtual float GetAngularDamping(void)
Returns the angular damping of the entity.
Definition: NSPhysicsEntity.qc:780
nonvirtual void SetMass(float)
Sets the mass of the entity in kilograms.
Definition: NSPhysicsEntity.qc:956
nonvirtual bool IsCollisionEnabled(void)
Returns whether the entity is able to collide with anything.
Definition: NSPhysicsEntity.qc:861
nonvirtual void _UpdateBuoyancy(void)
Definition: NSPhysicsEntity.qc:939
nonvirtual void SetDragCoefficient(float)
Call to set how much drag affects the entity.
Definition: NSPhysicsEntity.qc:916
nonvirtual float GetFriction(void)
Returns the friction multiplayer for this entity.
Definition: NSPhysicsEntity.qc:380
virtual void Save(float)
Handles saving a copy of this entity to a given filehandle.
Definition: NSPhysicsEntity.qc:81
nonvirtual void EnableMotion(bool)
Call to set whether the entity should be able to move.
Definition: NSPhysicsEntity.qc:768
nonvirtual void SetInertia(float)
Sets the angular inertia for this entity.
Definition: NSPhysicsEntity.qc:922
nonvirtual float GetLinearDamping(void)
Returns the linear damping of the entity.
Definition: NSPhysicsEntity.qc:774
nonvirtual vector GetMassCenter(void)
Returns the center of mass of the entity.
Definition: NSPhysicsEntity.qc:825
virtual void Pain(entity, entity, int, vector, int)
Called whenever the entity receives damage.
Definition: NSPhysicsEntity.qc:516
nonvirtual void ApplyForceCenter(vector)
Call to apply a force (absolute velocity vector) to the center of the entity.
Definition: NSPhysicsEntity.qc:688
virtual void Restore(string, string)
Similar to NSIO::SpawnKey but for save-game fields.
Definition: NSPhysicsEntity.qc:93
nonvirtual float GetInvMass(void)
Returns 1 divided by the mass of this entity.
Definition: NSPhysicsEntity.qc:813
nonvirtual void SetDamping(float, float)
Call to set the linear and angular damping of the entity.
Definition: NSPhysicsEntity.qc:909
virtual void Death(entity, entity, int, vector, int)
Called when the health is equal or below 0.
Definition: NSPhysicsEntity.qc:545
nonvirtual void Wake(void)
Call to enable physics simulation on this entity.
Definition: NSPhysicsEntity.qc:963
nonvirtual float CalculateImpactDamage(int, int)
Called by the physics routine to figure out the impact damage.
Definition: NSPhysicsEntity.qc:387
void NSPhysicsEntity(void)
Definition: NSPhysicsEntity.qc:24
nonvirtual void ApplyForceOffset(vector, vector)
Call to apply force (absolute velocity vector) to an absolute position on the entity.
Definition: NSPhysicsEntity.qc:709
virtual void Spawned(void)
Called when the entity is fulled initialized.
Definition: NSPhysicsEntity.qc:71
nonvirtual void Sleep(void)
Call to freeze physics simulation on this entity.
Definition: NSPhysicsEntity.qc:977
virtual void EvaluateEntity(void)
Run each tic after physics are run to determine if we need to send updates over the network.
Definition: NSPhysicsEntity.qc:138
nonvirtual void SetBuoyancyRatio(float)
Call to set the buoyancy ratio of the entity.
Definition: NSPhysicsEntity.qc:903
nonvirtual void EnableDrag(bool)
Call to set whether the entity should be affected by drag.
Definition: NSPhysicsEntity.qc:755
nonvirtual bool IsAsleep(void)
Returns whether the entity is at rest and not moving.
Definition: NSPhysicsEntity.qc:855
nonvirtual void _UpdateMass(void)
Definition: NSPhysicsEntity.qc:928
virtual void SpawnKey(string, string)
This method handles entity key/value pairs on map load.
Definition: NSPhysicsEntity.qc:634
This entity represents an NSRenderableEntity with interactive surface properties.
Definition: NSSurfacePropEntity.h:52
#define PREDICTED_FLOAT(x)
Definition: defs.h:34
#define PREDICTED_VECTOR(x)
Definition: defs.h:35