ncActor Class Reference

About this class

This entity class represents an object with choreographed/free-form movement.

It knows how to deal with waypoint based nodes and possibly other types of pathfinding in the future.

KEYS

• "snd_stepladder" : Sound to play when climbing a ladder.
• "snd_death" : Sound to play upon death.
• "snd_fall" : Sound to play upon taking falldamage.
• "snd_painSmall" : Sound to play when their health is still above 75%.
• "snd_painMedium" : Sound to play when their health is still above 50%.
• "snd_painLarge" : Sound to play when their health is still above 25%.
• "snd_painHuge" : Sound to play when their health is below 25%.
• "snd_landSoft" : Sound to play when landing from any height.
• "snd_landHard" : Sound to play upon a fall, although not damaging.
• "snd_hitArmor" : Sound to play when receiving damage and having some armor protection.
• "snd_hitFlesh" : Sound to play when receiving damage and having no armor protection.
• "snd_airGasp" : Sound to play when coming back up from under water.
• "snd_noAir" : Sound to play when struggling to breathe under water.
• "snd_teleportExit" : Sound to play when having exited a teleporter.
• "snd_teleportStart" : Sound to play when having entered a teleporter.
• "snd_burn" : Sound to play whenever incremental burn damage occurs.
• "snd_healthtake" : Sound to play when receiving a health increase.
• "snd_waterEnter" : Sound to play when entering water.
• "snd_waterExit" : Sound to play when exiting water.

INPUTS

• "UseItem" : Uses a named item in the actor their inventory.
• "GiveItem" : Gives a named item to the actor.
• "GiveAmmo" : Gives a named ammo type with a specific amount. Two arguments: "ammoTypeName" "count"
• "ChangeMindset" : Tells the actor to choose a different type of schedule.
• "PerformSchedule" : Performs a named schedule, defined in <gamedir>/decls/schedules/.
• "WalkToTarget" : Instruct the actor to walk to the last set target.
• "RunToTarget" : Instruct the actor to run to the last set target.
• "CrouchToTarget" : Instruct the actor to crouch to the last set target.
• "ProneToTarget" : Instruct the actor to prone to the last set target.
• "TargetNearestPlayer" : Target the nearest player from the actor's current position.
• "GoToCover" : Plot a route to promptly take cover.
• "GoToSpotInRadius" : Plot a route to an empty spot within a certain radius of the current position.
• "AvoidSpotInRadius" : Plot a route to a spot outside of a specified radius from the current position.
• "TurnToRandomYaw" : Turns the actor to a random direction.
• "GoForward" : Instruct to keep going forward.

Inheritance diagram for ncActor:

Public Member Functions
void	ncActor (void)
virtual bool	CanSprint (void)
	Overridable: Returns whether the client can sprint, with the command +sprint.
virtual bool	CanProne (void)
	Overridable: Returns whether the client can prone, with the commands +prone and goprone.
virtual bool	CanCrouch (void)
	Overridable: Returns whether the client can crouch, with the commands +crouch and gocrouch.
virtual bool	CanLean (void)
	Overridable: Returns whether the client can lean, with the commands +leanleft and +leanright.
virtual float	GetForwardSpeed (void)
	Overridable: Returns the desired maximum forward movement speed.
virtual float	GetSideSpeed (void)
	Overridable: Returns the desired maximum side movement speed.
virtual float	GetBackSpeed (void)
	Overridable: Returns the desired maximum backwardss movement speed.
nonvirtual float	GetStamina (void)
nonvirtual bool	IsCrouching (void)
	Returns true when the entity is ducked/crouching.
nonvirtual bool	IsProne (void)
	Returns true when the entity is ducked/crouching.
nonvirtual bool	IsStanding (void)
	Returns true when the entity is standing, walking.
nonvirtual bool	IsSprinting (void)
	Returns true when the entity is running.
nonvirtual bool	IsLeaning (void)
	Returns true when the entity is leaning.
nonvirtual bool	MaxAmmo (int)
	Returns whether the specified type is maxed out.
nonvirtual bool	GiveAmmo (int, int)
	Gives ammo up of a specified type.
nonvirtual bool	UseAmmo (int, int)
	Uses ammo up of a specified type.
nonvirtual bool	HasAmmo (int, int)
	Returns whether or not the entity has enough of the specified ammo and type.
nonvirtual int	GetReserveAmmo (int)
	Returns the amount of reserve ammo of a given type.
nonvirtual bool	GiveItem (string)
	Adds a named ncItem to the inventory.
nonvirtual bool	GiveExactItem (ncItem)
nonvirtual bool	RemoveItem (string)
	Removes a named ncItem from the inventory Returns false when impossible.
nonvirtual bool	AddItem (ncItem)
	Adds the specified ncItem to the inventory.
nonvirtual ncItem	GetItem (string)
	Returns true or false depending on if the entity has the named item.
nonvirtual bool	HasItem (string)
	Returns true or false depending on if the entity has the named item.
nonvirtual bool	HasExactItem (ncItem)
	Returns true or false depending on if the entity has the exact item.
nonvirtual bool	RemoveAllItems (bool)
	Removes all items from the inventory.
nonvirtual bool	RemoveAllWeapons (void)
	Removes all weapons from the inventory.
nonvirtual bool	RemoveWeaponInSlot (int)
	Removes the first item in someones specified inventory slot.
nonvirtual bool	DropWeaponInSlot (int)
	Drops the first item in someones specified inventory slot, placing it into the world in front of them.
nonvirtual string	GetCurrentWeapon (void)
	Returns the name of the current weapon.
nonvirtual void	SwitchToWeapon (string)
	Switches the entity to use the desired weapon.
nonvirtual void	SwitchToExactWeapon (ncWeapon)
	Switches the entity to use the desired weapon.
nonvirtual void	SwitchToBestWeapon (bool)
nonvirtual void	LaunchProjectile (string, bool, float)
nonvirtual bool	PlantCharge (string)
virtual ncWeapon	SortWeaponChain (void)
	Returns the first weapon in the chain, while ensuring the inventory is sorted.
nonvirtual ncWeapon	GetNextWeapon (void)
	Retrieve the 'next' weapon in the inventory, sorted by SortWeaponChain().
nonvirtual ncWeapon	GetPreviousWeapon (void)
	Retrieve the 'previous' weapon in the inventory, sorted by SortWeaponChain().
nonvirtual ncWeapon	GetLastWeapon (void)
	Retrieve the 'last' weapon they had chosen.
virtual void	AddedItemCallback (ncItem)
virtual void	SpawnKey (string, string)
	This method handles entity key/value pairs on map load.
virtual void	ReloadCachedAttributes (void)
	Shared: Called on launch/reload to read variables from defaults.
virtual void	SetAnimationPrefix (string animPrefix)
virtual void	ReceiveEvent (float eventID)
virtual void	Save (float)
	Handles saving a copy of this entity to a given filehandle.
virtual void	Restore (string, string)
	Similar to ncIO::SpawnKey() but for save-game fields.
virtual void	RestoreComplete (void)
	Called when the entity has been successfully restored from a savegame file.
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.
virtual void	Spawned (void)
	Called when the entity is fulled initialized.
virtual void	Input (entity, string, string)
	Called when we are being prompted by another object/function with an input message.
virtual void	DebugDraw (void)
virtual void	OnRemoveEntity (void)
	Handles what happens before the entity gets removed from the client game.
virtual void	Death (entity inflictor, entity attacker, int damagePoints, vector dir, vector absImpactPos, int hitBody)
	Called when the health is equal or below 0.
virtual void	SelectNewSchedule (void)
	Overridable: Called regularily to select a new schedule to perform.
nonvirtual void	ThinkSchedules (void)
nonvirtual bool	CancelSchedule (void)
	Forces a named schedule to be performed.
nonvirtual void	PerformSchedule (string)
nonvirtual void	MessageSchedule (string)
nonvirtual bool	IsPerforming (void)
nonvirtual int	PathNodeCount (void)
nonvirtual int	PathCurrentNode (void)
nonvirtual vector	PathDestination (void)
nonvirtual ncEntity	MakeCorpse (float deathSequence)
	Call to make a corpse of this actor.
virtual bool	CanCrouch (void)
	Returns if this class is capable of crouching.
nonvirtual vector	GetRouteMovevalues (void)
	Returns the current movement values in a single vector (x = fwd, y = rt, y = up)
nonvirtual vector	GetRouteDirection (void)
	Returns the current movement direction.
nonvirtual void	SetMoveSpeedScale (float)
	Sets the scale on the movement before physics are run.
nonvirtual float	GetMoveSpeedScale (void)
	Returns the movement speed scale.
virtual void	RouteEnded (void)
	Called when the object is done moving to its destination.
virtual void	RouteClear (void)
	When called, will wipe any memory of an ongoing route.
virtual void	CheckRouteProgression (void)
	Internal use only.
virtual void	RouteToPosition (vector)
	When called, will plot a route to a given world coordinate and start moving.
virtual void	RouteToPositionDenyFlags (vector, int)
	When called, will plot a route to a given world coordinate and start moving, ignoring any links that contain the given link flags.
virtual void	ChasePath (string startPath)
	When called, will start following a path_corner.
virtual void	CheckRouteProgression_Path (void)
	Internal use only.
virtual void	Physics_Run (void)
	Overridable: Called when the entity is ready to move.
virtual void	FiredWeapon (string, string)
nonvirtual void	__FiredWeapon (string, string)
virtual void	Event_DrawWeapon (void)
virtual void	Event_FireWeapon (void)
virtual void	Event_ReloadWeaponStart (void)
virtual void	Event_ReloadWeapon (void)
virtual void	Event_ReloadWeaponEnd (void)
virtual void	Event_HolsterWeapon (void)

Constructor & Destructor Documentation

ncActor()

void ncActor::ncActor

(

void

)

Member Function Documentation

__FiredWeapon()

void ncActor::__FiredWeapon	(	string	weaponDef,
		string	fireInfo )

AddedItemCallback()

void ncActor::AddedItemCallback ( ncItem itemAdded )

virtual

Reimplemented in ncBot.

AddItem()

bool ncActor::AddItem

(

ncItem

theItem

)

Adds the specified ncItem to the inventory.

Returns false when impossible.

CancelSchedule()

bool ncActor::CancelSchedule

(

void

)

Forces a named schedule to be performed.

CanCrouch() [1/2]

bool ncActor::CanCrouch ( void )

virtual

Overridable: Returns whether the client can crouch, with the commands +crouch and gocrouch.

Reimplemented in ncPlayer.

CanCrouch() [2/2]

virtual bool ncActor::CanCrouch ( void )

virtual

Returns if this class is capable of crouching.

Reimplemented in ncPlayer.

CanLean()

bool ncActor::CanLean ( void )

virtual

Overridable: Returns whether the client can lean, with the commands +leanleft and +leanright.

Reimplemented in ncPlayer.

CanProne()

bool ncActor::CanProne ( void )

virtual

Overridable: Returns whether the client can prone, with the commands +prone and goprone.

Reimplemented in ncPlayer.

CanSprint()

bool ncActor::CanSprint ( void )

virtual

Overridable: Returns whether the client can sprint, with the command +sprint.

Reimplemented in ncPlayer.

ChasePath()

void ncActor::ChasePath ( string startPath )

virtual

When called, will start following a path_corner.

CheckRouteProgression()

void ncActor::CheckRouteProgression ( void )

virtual

Internal use only.

Called every frame to see our route progression.

CheckRouteProgression_Path()

void ncActor::CheckRouteProgression_Path ( void )

virtual

Internal use only.

Called every frame to see our route progression.

Death()

void ncActor::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.

Reimplemented in ncMonster, and ncPlayer.

DebugDraw()

void ncActor::DebugDraw ( void )

virtual

Reimplemented from ncEntity.

Reimplemented in ambient_generic, ncMonster, and ncMonster.

DropWeaponInSlot()

bool ncActor::DropWeaponInSlot

(

int

desiredSlot

)

Drops the first item in someones specified inventory slot, placing it into the world in front of them.

Return values equals whether the inventory was changed.

Event_DrawWeapon()

void ncActor::Event_DrawWeapon ( void )

virtual

Event_FireWeapon()

void ncActor::Event_FireWeapon ( void )

virtual

Event_HolsterWeapon()

void ncActor::Event_HolsterWeapon ( void )

virtual

Event_ReloadWeapon()

void ncActor::Event_ReloadWeapon ( void )

virtual

Event_ReloadWeaponEnd()

void ncActor::Event_ReloadWeaponEnd ( void )

virtual

Event_ReloadWeaponStart()

void ncActor::Event_ReloadWeaponStart ( void )

virtual

FiredWeapon()

void ncActor::FiredWeapon ( string weaponDef, string fireInfo )

virtual

GetBackSpeed()

float ncActor::GetBackSpeed ( void )

virtual

Overridable: Returns the desired maximum backwardss movement speed.

Reimplemented in ncBot, and ncClient.

GetCurrentWeapon()

string ncActor::GetCurrentWeapon

(

void

)

Returns the name of the current weapon.

E.g. "weapon_foobar"

GetForwardSpeed()

float ncActor::GetForwardSpeed ( void )

virtual

Overridable: Returns the desired maximum forward movement speed.

Reimplemented in ncBot, and ncClient.

GetItem()

ncItem ncActor::GetItem

(

string

itemName

)

Returns true or false depending on if the entity has the named item.

GetLastWeapon()

ncWeapon ncActor::GetLastWeapon

(

void

)

Retrieve the 'last' weapon they had chosen.

If not valid, returns the next best.

GetMoveSpeedScale()

float ncActor::GetMoveSpeedScale

(

void

)

Returns the movement speed scale.

GetNextWeapon()

ncWeapon ncActor::GetNextWeapon

(

void

)

Retrieve the 'next' weapon in the inventory, sorted by SortWeaponChain().

GetPreviousWeapon()

ncWeapon ncActor::GetPreviousWeapon

(

void

)

Retrieve the 'previous' weapon in the inventory, sorted by SortWeaponChain().

GetReserveAmmo()

int ncActor::GetReserveAmmo

(

int

ammoType

)

Returns the amount of reserve ammo of a given type.

GetRouteDirection()

vector ncActor::GetRouteDirection

(

void

)

Returns the current movement direction.

GetRouteMovevalues()

vector ncActor::GetRouteMovevalues

(

void

)

Returns the current movement values in a single vector (x = fwd, y = rt, y = up)

GetSideSpeed()

float ncActor::GetSideSpeed ( void )

virtual

Overridable: Returns the desired maximum side movement speed.

Reimplemented in ncBot, and ncClient.

GetStamina()

float ncActor::GetStamina

(

void

)

GiveAmmo()

bool ncActor::GiveAmmo	(	int	ammoType,
		int	ammoAmount )

Gives ammo up of a specified type.

Returns false when impossible.

GiveExactItem()

bool ncActor::GiveExactItem

(

ncItem

theItem

)

GiveItem()

bool ncActor::GiveItem

(

string

itemName

)

Adds a named ncItem to the inventory.

Returns false when impossible.

HasAmmo()

bool ncActor::HasAmmo	(	int	ammoType,
		int	ammoAmount )

Returns whether or not the entity has enough of the specified ammo and type.

HasExactItem()

bool ncActor::HasExactItem

(

ncItem

itemEntity

)

Returns true or false depending on if the entity has the exact item.

HasItem()

bool ncActor::HasItem

(

string

itemName

)

Returns true or false depending on if the entity has the named item.

Input()

void ncActor::Input ( entity eAct, string strInput, string strData )

virtual

Called when we are being prompted by another object/function with an input message.

Reimplemented from ncSurfacePropEntity.

Reimplemented in ambient_generic, ncMonster, ncPlayer, ncSquadMonster, and ncTalkMonster.

IsCrouching()

bool ncActor::IsCrouching

(

void

)

Returns true when the entity is ducked/crouching.

IsLeaning()

bool ncActor::IsLeaning

(

void

)

Returns true when the entity is leaning.

IsPerforming()

bool ncActor::IsPerforming

(

void

)

IsProne()

bool ncActor::IsProne

(

void

)

Returns true when the entity is ducked/crouching.

IsSprinting()

bool ncActor::IsSprinting

(

void

)

Returns true when the entity is running.

IsStanding()

bool ncActor::IsStanding

(

void

)

Returns true when the entity is standing, walking.

LaunchProjectile()

void ncActor::LaunchProjectile	(	string	defName,
		bool	thrown,
		float	timeOfs )

MakeCorpse()

ncEntity ncActor::MakeCorpse

(

float

deathSequence

)

Call to make a corpse of this actor.

MaxAmmo()

bool ncActor::MaxAmmo

(

int

ammoType

)

Returns whether the specified type is maxed out.

MessageSchedule()

void ncActor::MessageSchedule

(

string

messageString

)

OnRemoveEntity()

void ncActor::OnRemoveEntity ( void )

virtual

Handles what happens before the entity gets removed from the client game.

Reimplemented from ncRenderableEntity.

Reimplemented in ambient_generic, ncClient, ncPlayer, and ncSpectator.

PathCurrentNode()

int ncActor::PathCurrentNode

(

void

)

PathDestination()

vector ncActor::PathDestination

(

void

)

PathNodeCount()

int ncActor::PathNodeCount

(

void

)

PerformSchedule()

void ncActor::PerformSchedule

(

string

scheduleDecl

)

Physics_Run()

void ncActor::Physics_Run ( void )

virtual

Overridable: Called when the entity is ready to move.

When overridden, will no longer move until super function is called, or physics is handled within.

Reimplemented in ncPlayer.

PlantCharge()

bool ncActor::PlantCharge

(

string

defName

)

ReceiveEvent()

void ncActor::ReceiveEvent ( float eventID )

virtual

Reimplemented from ncEntity.

ReloadCachedAttributes()

void ncActor::ReloadCachedAttributes ( void )

virtual

Shared: Called on launch/reload to read variables from defaults.

Data that doesn't get saved.

Reimplemented from ncIO.

RemoveAllItems()

bool ncActor::RemoveAllItems

(

bool

ignoreWeapons

)

Removes all items from the inventory.

Returns false when already empty.

RemoveAllWeapons()

bool ncActor::RemoveAllWeapons

(

void

)

Removes all weapons from the inventory.

Returns false when already clear.

RemoveItem()

bool ncActor::RemoveItem

(

string

itemName

)

Removes a named ncItem from the inventory Returns false when impossible.

RemoveWeaponInSlot()

bool ncActor::RemoveWeaponInSlot

(

int

desiredSlot

)

Removes the first item in someones specified inventory slot.

Return values equals whether the inventory was changed.

Respawn()

void ncActor::Respawn ( void )

virtual

Server: Called when the entity first spawns or when game-logic requests the entity to return to its original spawn state.

Reimplemented from ncSurfacePropEntity.

Reimplemented in ambient_generic, monster_furniture, monster_generic, ncMonster, ncPlayer, ncSpectator, ncTalkMonster, and speaker.

Restore()

void ncActor::Restore ( string keyName, string setValue )

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

Reimplemented in ambient_generic, ncClient, ncMonster, ncPlayer, ncSpectator, ncSquadMonster, ncTalkMonster, and speaker.

RestoreComplete()

void ncActor::RestoreComplete ( void )

virtual

Called when the entity has been successfully restored from a savegame file.

Reimplemented from ncSurfacePropEntity.

RouteClear()

void ncActor::RouteClear ( void )

virtual

When called, will wipe any memory of an ongoing route.

Reimplemented in ncBot, and ncMonster.

RouteEnded()

void ncActor::RouteEnded ( void )

virtual

Called when the object is done moving to its destination.

Reimplemented in ncMonster.

RouteToPosition()

void ncActor::RouteToPosition ( vector destination )

virtual

When called, will plot a route to a given world coordinate and start moving.

RouteToPositionDenyFlags()

void ncActor::RouteToPositionDenyFlags ( vector destination, int denylinkflags )

virtual

When called, will plot a route to a given world coordinate and start moving, ignoring any links that contain the given link flags.

Save()

void ncActor::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 ncSurfacePropEntity.

Reimplemented in ambient_generic, ncClient, ncMonster, ncPlayer, ncSpectator, ncSquadMonster, ncTalkMonster, and speaker.

SelectNewSchedule()

void ncActor::SelectNewSchedule ( void )

virtual

Overridable: Called regularily to select a new schedule to perform.

SetAnimationPrefix()

void ncActor::SetAnimationPrefix ( string animPrefix )

virtual

SetMoveSpeedScale()

void ncActor::SetMoveSpeedScale

(

float

newValue

)

Sets the scale on the movement before physics are run.

This is used to simulate walking. 0 is treated as 1 (no change).

SortWeaponChain()

ncWeapon ncActor::SortWeaponChain ( void )

virtual

Returns the first weapon in the chain, while ensuring the inventory is sorted.

Spawned()

void ncActor::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 ncSurfacePropEntity.

Reimplemented in ambient_generic, ncClient, ncMonster, ncPlayer, ncSquadMonster, and speaker.

SpawnKey()

void ncActor::SpawnKey ( string keyName, string setValue )

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

Reimplemented in ambient_generic, monster_furniture, ncMonster, ncSquadMonster, ncTalkMonster, and speaker.

SwitchToBestWeapon()

void ncActor::SwitchToBestWeapon

(

bool

ignoreActive

)

SwitchToExactWeapon()

void ncActor::SwitchToExactWeapon

(

ncWeapon

item

)

Switches the entity to use the desired weapon.

SwitchToWeapon()

void ncActor::SwitchToWeapon

(

string

weaponName

)

Switches the entity to use the desired weapon.

ThinkSchedules()

void ncActor::ThinkSchedules

(

void

)

UseAmmo()

bool ncActor::UseAmmo	(	int	ammoType,
		int	ammoAmount )

Uses ammo up of a specified type.

Returns false when impossible.

---

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

• src/shared/game/Actor.h
• src/shared/game/Actor.qc