Nuclide
Software Development Kit for id Tech
|
This entity represents any NSEntity with advanced rendering properties. More...
#include <NSRenderableEntity.h>
Public Member Functions | |
void | NSRenderableEntity (void) |
virtual void | SpawnKey (string, string) |
This method handles entity key/value pairs on map load. More... | |
virtual void | Input (entity, string, string) |
Called when we are being prompted by another object/function with an input message. More... | |
virtual void | Respawn (void) |
Server: Called when the entity first spawns or when game-logic requests the entity to return to its original spawn state. More... | |
virtual void | Save (float) |
Handles saving a copy of this entity to a given filehandle. More... | |
virtual void | Restore (string, string) |
Similar to NSIO::SpawnKey but for save-game fields. More... | |
virtual void | EvaluateEntity (void) |
Run each tic after physics are run to determine if we need to send updates over the network. More... | |
virtual float | SendEntity (entity, float) |
Called by the engine whenever we need to send a client an update about this entity. More... | |
virtual void | RenderDebugSkeleton (void) |
virtual void | ReceiveEntity (float, float) |
Client: Handles network updates from the server for the associated entity. More... | |
virtual float | predraw (void) |
virtual void | postdraw (void) |
Client: Run after the rendering of 3D world is complete. More... | |
virtual void | RendererRestarted () |
Client: Called when video resources need to be allocated or reloaded for the entity. More... | |
virtual void | MakeStatic (void) |
Tells the engine to make the entity static, effectively making it inaccessible. More... | |
virtual void | HandleAnimEvent (float, int, string) |
Callback for any model event that gets triggered while playing a framegroup. More... | |
nonvirtual void | SetBody (int) |
Sets the bodygroup of the entity. More... | |
nonvirtual void | SetBodyInGroup (int, int) |
Sets the body inside of a specific group. More... | |
nonvirtual void | SetRenderFX (float) |
Sets the render FX type of the entity. More... | |
nonvirtual void | SetRenderMode (float) |
Sets the render mode type of the entity. More... | |
nonvirtual void | SetRenderAmt (float) |
Sets the render amount of the entity. More... | |
nonvirtual void | SetRenderColor (vector) |
Sets the render color of the entity. More... | |
nonvirtual void | SetBoneControl1 (float) |
Sets the value of the bone controller #1. More... | |
nonvirtual void | SetBoneControl2 (float) |
Sets the value of the bone controller #2. More... | |
nonvirtual void | SetBoneControl3 (float) |
Sets the value of the bone controller #3. More... | |
nonvirtual void | SetBoneControl4 (float) |
Sets the value of the bone controller #4. More... | |
nonvirtual void | SetBoneControl5 (float) |
Sets the value of the bone controller #5. More... | |
nonvirtual void | SetAxialScale (vector) |
Sets the axial, anisotropic scale of an entity, affecting the individual axis (forward, right, up). More... | |
nonvirtual int | GetBody (void) |
Returns the bodygroup of the entity. More... | |
nonvirtual int | GetBodyInGroup (int) |
Returns the body within a given group. More... | |
nonvirtual float | GetRenderMode (void) |
Returns the render mode of the entity. More... | |
nonvirtual float | GetRenderFX (void) |
Returns the render FX of the entity. More... | |
nonvirtual float | GetRenderAmt (void) |
Returns the render amount of the entity. More... | |
nonvirtual vector | GetRenderColor (void) |
Returns the render color of the entity. More... | |
nonvirtual float | GetBoneControl1 (void) |
Returns the value of the entity's bone controller #1. More... | |
nonvirtual float | GetBoneControl2 (void) |
Returns the value of the entity's bone controller #2. More... | |
nonvirtual float | GetBoneControl3 (void) |
Returns the value of the entity's bone controller #3. More... | |
nonvirtual float | GetBoneControl4 (void) |
Returns the value of the entity's bone controller #4. More... | |
nonvirtual float | GetBoneControl5 (void) |
Returns the value of the entity's bone controller #5. More... | |
nonvirtual vector | GetAxialScale (void) |
Returns the axial/anisotropic scale of the entity, same as input format (forward, right, up) More... | |
nonvirtual void | RenderFXPass (void) |
Called by predraw(); and will set the appropriate rendering specific fields. More... | |
nonvirtual void | RenderAxialScale (void) |
nonvirtual void | RenderGLQuakeShadow (void) |
This entity represents any NSEntity with advanced rendering properties.
This includes GoldSource and Source Engine style rendering effects.
This is the bare minimum for most characters as it allows for body and bone control settings.
Run each tic after physics are run to determine if we need to send updates over the network.
Reimplemented from NSEntity.
Reimplemented in func_tracktrain, ambient_generic, env_beam, env_funnel, env_glow, env_laser, env_smoker, env_sprite, func_conveyor, speaker, NSClientPlayer, NSClientSpectator, NSItem, NSMonster, NSPhysicsEntity, NSProjectile, NSSurfacePropEntity, NSVehicle, and NSWeapon.
vector NSRenderableEntity::GetAxialScale | ( | void | ) |
Returns the axial/anisotropic scale of the entity, same as input format (forward, right, up)
int NSRenderableEntity::GetBody | ( | void | ) |
Returns the bodygroup of the entity.
int NSRenderableEntity::GetBodyInGroup | ( | int | bodyGroup | ) |
Returns the body within a given group.
Returns the value of the entity's bone controller #1.
Returns the value of the entity's bone controller #2.
Returns the value of the entity's bone controller #3.
Returns the value of the entity's bone controller #4.
Returns the value of the entity's bone controller #5.
vector NSRenderableEntity::GetRenderColor | ( | void | ) |
Returns the render color of the entity.
Callback for any model event that gets triggered while playing a framegroup.
Reimplemented in NSTalkMonster.
Called when we are being prompted by another object/function with an input message.
Reimplemented from NSEntity.
Reimplemented in env_shooter, func_door, func_guntarget, func_plat, func_wall_toggle, ambient_generic, env_funnel, env_smoker, func_conveyor, NSMonster, and NSSurfacePropEntity.
Tells the engine to make the entity static, effectively making it inaccessible.
It will be removed from the game-logic but remain visible and it will retain its collision and maintain the appearance it had before getting removed.
Reimplemented from NSEntity.
Client: Run after the rendering of 3D world is complete.
2D calls can happen here.
Reimplemented from NSEntity.
Reimplemented in NSClientPlayer, and NSPhysicsEntity.
Reimplemented from NSEntity.
Reimplemented in func_lod, NSClient, NSClientPlayer, NSClientSpectator, NSMonster, NSProjectile, NSSurfacePropEntity, and NSTalkMonster.
Client: Handles network updates from the server for the associated entity.
Reimplemented from NSEntity.
Reimplemented in func_tracktrain, func_conveyor, func_monitor, func_tankmortar, prop_vehicle_driveable, speaker, NSClientPlayer, NSClientSpectator, NSItem, NSMonster, NSPhysicsEntity, NSProjectile, NSSurfacePropEntity, NSTalkMonster, NSVehicle, and NSWeapon.
Client: Called when video resources need to be allocated or reloaded for the entity.
Reimplemented from NSEntity.
Called by predraw(); and will set the appropriate rendering specific fields.
Server: Called when the entity first spawns or when game-logic requests the entity to return to its original spawn state.
Reimplemented from NSEntity.
Reimplemented in prop_static, button_target, cycler, env_model, env_shooter, func_breakable, func_brush, func_button, func_door, func_door_rotating, func_guntarget, func_healthcharger, func_pendulum, func_physbox, func_plat, func_platrot, func_pushable, func_recharge, func_rot_button, func_rotating, func_tank, func_tracktrain, func_train, func_wall_toggle, item_eyescanner, item_food, item_generic, item_healthcharger, item_recharge, momentary_door, momentary_rot_button, monster_furniture, monster_generic, prop_door_rotating, prop_dynamic, prop_physics, prop_static, ambient_generic, env_beam, env_funnel, env_glow, env_laser, env_smoker, func_conveyor, func_illusionary, func_ladder, func_lod, func_wall, speaker, NSClientPlayer, NSItem, NSMonster, NSPhysicsEntity, NSSurfacePropEntity, and NSTalkMonster.
Similar to NSIO::SpawnKey
but for save-game fields.
Whatever you write into file handles within your NSIO::Save()
method needs to be read back in here.
Reimplemented from NSEntity.
Reimplemented in env_beverage, env_fade, env_shooter, func_breakable, func_brush, func_button, func_door, func_door_rotating, func_guntarget, func_healthcharger, func_pendulum, func_plat, func_platrot, func_pushable, func_recharge, func_rot_button, func_rotating, func_tank, func_trackchange, func_tracktrain, func_train, func_wall_toggle, item_food, item_generic, item_healthcharger, item_recharge, momentary_rot_button, NSMomentary, player_loadsaved, prop_door_rotating, ambient_generic, env_funnel, env_smoker, func_conveyor, speaker, NSClient, NSClientPlayer, NSClientSpectator, NSItem, NSMonster, NSMoverEntity, NSActor, NSPhysicsEntity, NSProjectile, NSSquadMonster, NSSurfacePropEntity, NSTalkMonster, NSVehicle, and NSWeapon.
Handles saving a copy of this entity to a given filehandle.
Within you want to use the NSIO::SaveFloat() etc. methods to write the internal member attributes to the specified file handle.
Reimplemented from NSEntity.
Reimplemented in env_beverage, env_fade, env_shooter, func_breakable, func_brush, func_button, func_door, func_door_rotating, func_guntarget, func_healthcharger, func_pendulum, func_plat, func_platrot, func_pushable, func_recharge, func_rot_button, func_rotating, func_tank, func_trackchange, func_tracktrain, func_train, func_wall_toggle, item_food, item_generic, item_healthcharger, item_recharge, momentary_rot_button, NSMomentary, player_loadsaved, prop_door_rotating, ambient_generic, env_funnel, env_smoker, func_conveyor, speaker, NSClient, NSClientPlayer, NSClientSpectator, NSItem, NSMonster, NSMoverEntity, NSActor, NSPhysicsEntity, NSProjectile, NSSquadMonster, NSSurfacePropEntity, NSTalkMonster, NSVehicle, and NSWeapon.
Called by the engine whenever we need to send a client an update about this entity.
Reimplemented from NSEntity.
Reimplemented in func_tracktrain, ambient_generic, env_beam, env_funnel, env_glow, env_laser, env_smoker, env_sprite, func_conveyor, func_lod, speaker, NSClientPlayer, NSClientSpectator, NSItem, NSMonster, NSPhysicsEntity, NSProjectile, NSSurfacePropEntity, NSTalkMonster, NSVehicle, and NSWeapon.
void NSRenderableEntity::SetAxialScale | ( | vector | scaleVec | ) |
Sets the axial, anisotropic scale of an entity, affecting the individual axis (forward, right, up).
void NSRenderableEntity::SetBody | ( | int | newBody | ) |
Sets the bodygroup of the entity.
void NSRenderableEntity::SetBodyInGroup | ( | int | groupID, |
int | bodyValue | ||
) |
Sets the body inside of a specific group.
Sets the render amount of the entity.
This depdends on the context.
void NSRenderableEntity::SetRenderColor | ( | vector | newColor | ) |
Sets the render color of the entity.
Sets the render FX type of the entity.
Check renderfx_t for details.
Sets the render mode type of the entity.
Check rendermode_t for details.
This method handles entity key/value pairs on map load.
You can easily convert the strValue
parameter using the ReadFloat etc. methods that are part of NSIO.
Reimplemented from NSEntity.
Reimplemented in prop_static, env_beverage, env_fade, env_model, env_shooter, func_breakable, func_brush, func_button, func_door, func_door_rotating, func_guntarget, func_healthcharger, func_pendulum, func_physbox, func_plat, func_platrot, func_pushable, func_recharge, func_rot_button, func_rotating, func_tank, func_trackchange, func_tracktrain, func_train, item_eyescanner, item_generic, item_healthcharger, item_recharge, momentary_door, momentary_rot_button, monster_furniture, player_loadsaved, prop_door_rotating, prop_dynamic, prop_physics, ambient_generic, env_beam, env_funnel, env_glow, env_laser, env_smoker, env_sprite, func_conveyor, func_lod, speaker, NSItem, NSMonster, NSMoverEntity, NSPhysicsEntity, NSProjectile, NSSquadMonster, NSSurfacePropEntity, NSTalkMonster, and NSWeapon.