About this class

This entity class represents an interactive projectile.

OVERVIEW

Objects such as rockets, grenades, bolts etc. should ideally be this class. Weapons are the primary source of firing this projectile, but any actor and other entity can launch these as well.

ncEntity can use its inputs SpawnProjectileDef and SpawnProjectileOffset anywhere in the game to spawn a projectile. Refer to ncEntity its own documentation for details.

KEYS

"model" : Model of the projectile.
"mins" : Mins of the projectile bounding box.
"maxs" : Maxs of the projectile bounding box.
"def_damage" : direct damage, upon touch
"def_splash_damage" : splash damage damage def
"velocity" : Start velocity. Main speed control when thrust isn't on. Relative to view (forward, right, up).
"health" : amount of dmg the projectile can take
"angular_velocity" : Specifies the angular velocity. Pitch/yaw/roll per second.
"thrust" : Rate of acceeleration.
"thrust_start" : When to begin accel, in seconds.
"thrust_end" : When to stop accel, in seconds.
"linear_friction" : Air friction.
"bounce" : Bounce to speed multiplier.
"gravity" : 0 means no gravity.
"fuse" : Fuse time in seconds.
"detonate_on_fuse" : When 1, will detonate when fuse runs out.
"detonate_on_death" : When 1, makes it it detonate when it gets damaged enough.
"detonate_on_world" : When 1, detonates when touching world.
"detonate_on_actor" : When 1 touching a monster/player will detonate it.
"decal_detonate" : Name of the decal group to place.
"smoke_fly" : Particle effect to use when flying.
"fx_path" : Particle trail to use when flying.
"model_detonate" : Particle effect to play when the projectile explodes.
"smoke_bounce" : Smoke effect to play when bouncing around.
"smoke_fuse" : Particle effect to play when the fuse timer runs out.
"projectile_debris" : Another projectile to spawn when this one detonates.
"debris_count" : Number of projectiles to spawn upon detonation.
"debris_stick" : When 1, projectiles will stick to walls.
"debris_offset" : Offset at which debris is spawned from the impact position, aiming away from the impact normal. In units, forward/right/up vector.
"detonate_offset" : Offset at which the particles and lights occur during explosion.
"damage_offset" : The offset at which explosion damage will be calculated from. In units, forward/right/up vector.
"light_color" : Flying dynamic light color.
"light_radius" : Flying dynamic light radius.
"light_offset" : Flying dynamic light offset.
"explode_light_color" : Explosion dynamic light color.
"explode_light_radius" : Explosion dynamic light radius.
"explode_light_fadetime" : Explosion dynamic light fade time.
"snd_fly" : Sound to play when flying.
"snd_explode" : Sound to play when exploding.
"snd_bounce" : Sound to play when bouncing around, not exploding.
"decal_impact" : Decal group to spawn upon impact.
"stick_to_world" : When 1, will stick to world.
"stick_to_actor" : When 1, will stick to actors.
"thrust_homing" : When 1, will change the thrust to act as a homing missile.
"frame" : Animation sequence to use when flying.
"inherit_velocity" : When 1, will inherit the velocity from the owner.
"offset" : Offset position from the owner. In units from face. Vector axis are [forward] [right] [up].
"damage" : Damage upon direct impact, respected when "def_damage" is not set.
"thrown" : Will not fly like a rocket, but be thrown like a grenade. Hold-time will be passed as a fuse.
"reflects" : When 1, will reflect off surfaces.
"trackEnemy" : When 1, will track the nearest enemy.
"trackJitter" : Will jitter movement when tracking by this many units per second.
"trackDelay" : Delay between tracking position updates.
"def_planeImpact" : When set, will spawn an entity at the position of impact aligned towards the impact surface's normal.
"noFX" : Disable impact effects.

UNUSED

"mass" : Reserved.
"impact_damage_effect" : Reserved. May affect blood splats?
"impact_gib" : impact gibs? Reserved.
"decal_size" : Reserved.
"smoke_detonate" : Reserved.

HITSCAN KEYS

"is_bullet": When 1, will act as a traceline/hitscan bullet instead of a projectile.
"hitscans": Number of hitscans cast when "is_bullet" is 1.
"spread": Spread of the projectile flying direction (e.g. "0.1 0.1")
"range": Hitscan maximum range.

SPRITE KEYS

"animStartFrame" : Animation start frame.
"animEndFrame" : Animation end frame.
"animFrameRate" : Animation frame rate.
"animEndRemoves" : Remove projectile once animation finishes.

EXAMPLES

A projectile for a shotgun may look like this:

entityDef projectile_shotgun
{
    "spawnclass"            "ncProjectile"
    "is_bullet"             "1"
    "detonate_on_world"     "1"
    "damage"                "10"
    "hitscans"              "6"
    "spread"                "0.1 0.1"
}

Here's one for a rocket, fired from a rocket launcher. The // comments indicate where you'd have to define the extra effects:

entityDef damage_rocketDirect
{
    "damage"        "80"
    "damage_random" "25" // adds up to 25 units of damage on top
}
 
entityDef damage_rocketSplash
{
    "damage"    "200"
    "radius"    "250"
    "push"      "10000"
}
 
entityDef projectile_rocket
{
    "spawnclass"                "ncProjectile"
    "model"                     "models/rocket.vvm"
 
    "def_damage"                "damage_rocketDirect"
    "def_splash_damage"         "damage_rocketSplash"
 
    "velocity"                  "250"
    "angular_velocity"          "0 0 200"
    "fuse"                      "10"
    "detonate_on_fuse"          "0"
    "detonate_on_death"         "1"
    "detonate_on_world"         "1"
    "detonate_on_actor"         "1"
    "impact_damage_effect"      "1"
    "impact_gib"                "1"
 
    "thrust"                    "2000"
    "thrust_start"              "0.1"
    "thrust_end"                "2"
 
    "smoke_fly"                 "weapon_rocketlauncher.smoke_trail" // define `smoke_trail` in particles/weapon_rocketlauncher.cfg
    "model_detonate"            "weapon_rocketlauncher.explosion" // define `explosion` in particles/weapon_rocketlauncher.cfg
    "decal_detonate"            "ExplosionDecal" // define `ExplosionDecal` in scripts/decals.txt
    "light_color"               "1 1 1"
    "light_radius"              "160"
    "light_offset"              "0 0 0"
    "detonate_offset"           "24"
 
    "explode_light_color"       "2 1.6 0.8"
    "explode_light_radius"      "320"
    "explode_light_fadetime"    "0.5"
 
    "snd_explode"               "Weapon_RocketLauncher.Explosion" // define it in decls/sound/weapons.sndshd
    "offset"                    "0 7 -3"
}

Inheritance diagram for ncProjectile:

Public Member Functions
void	ncProjectile (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...

nonvirtual void	SetImpact (void(entity, entity))
	Sets the function that'll be called upon impact of the projectile onto a surface. More...

nonvirtual void	Animate (int, int, float)
	When called, will animated between two frame positions at a specified framerate on loop. More...

nonvirtual void	AnimateOnce (int, int, float)
	When called, will animated between two frame positions at a specified framerate and remove itself when it has finished playing the sequence. More...

virtual void	Touch (entity)
	Called upon the projectile touching another object. More...

virtual void	Spawned (void)
	Called when the entity is fulled initialized. More...

virtual void	Pain (entity, entity, int, vector, vector, int)
	Called whenever the entity receives damage. More...

virtual void	Death (entity, entity, int, vector, vector, int)
	Called when the health is equal or below 0. More...

virtual void	SpawnKey (string, string)
	This method handles entity key/value pairs on map load. 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	Save (float)
	Handles saving a copy of this entity to a given filehandle. More...

virtual void	Restore (string, string)
	Similar to ncIO::SpawnKey() but for save-game fields. More...

virtual void	Trigger (entity, triggermode_t)
	Called whenever we're legacy triggered by another object or function. More...

nonvirtual void	_FuseEnded (void)

nonvirtual void	_Explode (entity)

virtual void	HasExploded (void)

virtual void	_LaunchHitscan (vector, vector, float)

virtual void	Launch (vector, vector, float, float, float)

nonvirtual void	SetLightColor (vector)

nonvirtual void	SetLightRadius (float)

nonvirtual void	SetWeaponOwner (ncWeapon)

nonvirtual ncWeapon	GetWeaponOwner (void)

nonvirtual void	EnableDetonateOnFuse (bool)

nonvirtual void	EnableDetonateOnDeath (bool)

nonvirtual void	EnableDetonateOnWorld (bool)

nonvirtual void	EnableDetonateOnActor (bool)

nonvirtual void	EnableStickToWorld (bool)

nonvirtual void	EnableStickToActor (bool)

nonvirtual void	EnableThrustHoming (bool)

nonvirtual void	EnableInheritVelocity (bool)

Constructor & Destructor Documentation

◆ ncProjectile()

void ncProjectile::ncProjectile ( void )

Member Function Documentation

◆ _Explode()

void ncProjectile::_Explode ( entity explodedOn )

◆ _FuseEnded()

void ncProjectile::_FuseEnded ( void )

◆ _LaunchHitscan()

void ncProjectile::_LaunchHitscan	(	vector	startPos,
		vector	launchDir,
		float	dmgMultiplier
	)

virtual

◆ Animate()

void ncProjectile::Animate	(	int	startframe,
		int	endframe,
		float	framerate
	)

When called, will animated between two frame positions at a specified framerate on loop.

◆ AnimateOnce()

void ncProjectile::AnimateOnce	(	int	startframe,
		int	endframe,
		float	framerate
	)

When called, will animated between two frame positions at a specified framerate and remove itself when it has finished playing the sequence.

◆ Death()

void ncProjectile::Death	(	entity	inflictor,
		entity	attacker,
		int	damage,
		vector	dir,
		vector	absImpactPos,
		int	hitBody
	)

virtual

Called when the health is equal or below 0.

Reimplemented from ncSurfacePropEntity.

◆ EnableDetonateOnActor()

void ncProjectile::EnableDetonateOnActor ( bool enabled )

◆ EnableDetonateOnDeath()

void ncProjectile::EnableDetonateOnDeath ( bool enabled )

◆ EnableDetonateOnFuse()

void ncProjectile::EnableDetonateOnFuse ( bool enabled )

◆ EnableDetonateOnWorld()

void ncProjectile::EnableDetonateOnWorld ( bool enabled )

◆ EnableInheritVelocity()

void ncProjectile::EnableInheritVelocity ( bool enabled )

◆ EnableStickToActor()

void ncProjectile::EnableStickToActor ( bool enabled )

◆ EnableStickToWorld()

void ncProjectile::EnableStickToWorld ( bool enabled )

◆ EnableThrustHoming()

void ncProjectile::EnableThrustHoming ( bool enabled )

◆ EvaluateEntity()

void ncProjectile::EvaluateEntity ( void )

virtual

Run each tic after physics are run to determine if we need to send updates over the network.

Reimplemented from ncSurfacePropEntity.

◆ GetWeaponOwner()

ncWeapon ncProjectile::GetWeaponOwner ( void )

◆ HasExploded()

void ncProjectile::HasExploded ( void )

virtual

◆ Launch()

void ncProjectile::Launch	(	vector	startPos,
		vector	launchDir,
		float	fuseOffset,
		float	powerMultiplier,
		float	dmgMultiplier
	)

virtual

Reimplemented from ncAttack.

◆ Pain()

void ncProjectile::Pain	(	entity	inflictor,
		entity	attacker,
		int	damage,
		vector	dir,
		vector	absImpactPos,
		int	hitBody
	)

virtual

Called whenever the entity receives damage.

Reimplemented from ncSurfacePropEntity.

◆ postdraw()

void ncProjectile::postdraw ( void )

virtual

Client: Run after the rendering of 3D world is complete.

2D calls can happen here.

Reimplemented from ncRenderableEntity.

◆ predraw()

float ncProjectile::predraw ( void )

virtual

Reimplemented from ncSurfacePropEntity.

◆ ReceiveEntity()

void ncProjectile::ReceiveEntity	(	float	flNew,
		float	flChanged
	)

virtual

Client: Handles network updates from the server for the associated entity.

Reimplemented from ncSurfacePropEntity.

◆ Restore()

void ncProjectile::Restore	(	string	strKey,
		string	strValue
	)

virtual

Similar to ncIO::SpawnKey() but for save-game fields.

Whatever you write into file handles within your ncIO::Save() method needs to be read back in here.

Reimplemented from ncAttack.

◆ Save()

void ncProjectile::Save ( float handle )

virtual

Handles saving a copy of this entity to a given filehandle.

Within you want to use the ncIO::SaveFloat() etc. methods to write the internal member attributes to the specified file handle.

Reimplemented from ncAttack.

◆ SendEntity()

float ncProjectile::SendEntity	(	entity	,
		float
	)

virtual

Called by the engine whenever we need to send a client an update about this entity.

Reimplemented from ncSurfacePropEntity.

◆ SetImpact()

void ncProjectile::SetImpact ( void(entity, entity) )

Sets the function that'll be called upon impact of the projectile onto a surface.

◆ SetLightColor()

void ncProjectile::SetLightColor ( vector newColor )

◆ SetLightRadius()

void ncProjectile::SetLightRadius ( float newRadius )

◆ SetWeaponOwner()

void ncProjectile::SetWeaponOwner ( ncWeapon weaponOwner )

◆ Spawned()

void ncProjectile::Spawned ( void )

virtual

Called when the entity is fulled initialized.

Any spawn key/value info pairs have already been dealt with. So now we can make full decisions on the entity. Always make sure to call super::Spawned(); inside your method when overriding.

Reimplemented from ncAttack.

◆ SpawnKey()

void ncProjectile::SpawnKey	(	string	strKey,
		string	strValue
	)

virtual

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 ncIO.

Reimplemented from ncAttack.

◆ Touch()

void ncProjectile::Touch ( entity eToucher )

virtual

Called upon the projectile touching another object.

Reimplemented from ncTrigger.

◆ Trigger()

void ncProjectile::Trigger	(	entity	act,
		triggermode_t	state
	)

virtual

Called whenever we're legacy triggered by another object or function.

Reimplemented from ncTrigger.

The documentation for this class was generated from the following files:

src/shared/Projectile.h
src/shared/Projectile.qc

About this class

OVERVIEW

KEYS

UNUSED

HITSCAN KEYS

SPRITE KEYS

EXAMPLES

Public Member Functions

Constructor & Destructor Documentation

◆ ncProjectile()

Member Function Documentation

◆ _Explode()

◆ _FuseEnded()

◆ _LaunchHitscan()

◆ Animate()

◆ AnimateOnce()

◆ Death()

◆ EnableDetonateOnActor()

◆ EnableDetonateOnDeath()

◆ EnableDetonateOnFuse()

◆ EnableDetonateOnWorld()

◆ EnableInheritVelocity()

◆ EnableStickToActor()

◆ EnableStickToWorld()

◆ EnableThrustHoming()

◆ EvaluateEntity()

◆ GetWeaponOwner()

◆ HasExploded()

◆ Launch()

◆ Pain()

◆ postdraw()

◆ predraw()

◆ ReceiveEntity()

◆ Restore()

◆ Save()

◆ SendEntity()

◆ SetImpact()

◆ SetLightColor()

◆ SetLightRadius()

◆ SetWeaponOwner()

◆ Spawned()

◆ SpawnKey()

◆ Touch()

◆ Trigger()