path_corner Class Reference

About this class

Server-Entity: Train/Mover Path Node.

QUAKED path_corner (.5 .3 0) (-8 -8 -8) (8 8 8) PC_WAIT PC_TELEPORT PC_FIREONCE

OVERVIEW

Node entities used for func_trains and func_guntargets.

KEYS

• "targetname" : Name
• "target" : Next node.
• "message" : Target to trigger when a train passes this node.
• "speed" : New speed for passing train.
• "yaw_speed" : New yaw rotation for passing train. Currently unused.
• "wait" : Waiting time until we go to the next node.

INPUTS

• "OnPass" : Triggered when a 'train' passes over this node.

SPAWNFLAGS

• PC_WAIT (1) : Train will stop moving once passed. Needs retrigger to progress.
• PC_TELEPORT (2) : Train passing will immediately teleport to "target".
• PC_FIREONCE (4) : Only fire its target (message) once.

TRIVIA

This entity was introduced in Quake (1996).

Inheritance diagram for path_corner:

Public Member Functions
void	path_corner (void)
virtual void	Spawned (void)
	Called when the entity is fulled initialized.
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	SpawnKey (string, string)
	This method handles entity key/value pairs on map load.
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	Trigger (entity, triggermode_t)
	Called whenever we're legacy triggered by another object or function.
virtual string	GetPathTarget (void)
virtual string	GetSelfTarget (void)
virtual path_corner	GetPathTargetEntity (void)
virtual path_corner	GetSelfTargetEntity (void)
virtual bool	DisablesTrain (void)
virtual void	PathPassTrigger (entity, triggermode_t)
nonvirtual float	DesiredTrainSpeed (void)
nonvirtual float	DesiredTrainYawSpeed (void)
nonvirtual float	DesiredWaitTime (void)

Constructor & Destructor Documentation

path_corner()

void path_corner::path_corner

(

void

)

Member Function Documentation

DesiredTrainSpeed()

float path_corner::DesiredTrainSpeed

(

void

)

DesiredTrainYawSpeed()

float path_corner::DesiredTrainYawSpeed

(

void

)

DesiredWaitTime()

float path_corner::DesiredWaitTime

(

void

)

DisablesTrain()

bool path_corner::DisablesTrain ( void )

virtual

Reimplemented in path_track.

GetPathTarget()

string path_corner::GetPathTarget ( void )

virtual

Reimplemented in path_track.

GetPathTargetEntity()

path_corner path_corner::GetPathTargetEntity ( void )

virtual

Reimplemented in path_track.

GetSelfTarget()

string path_corner::GetSelfTarget ( void )

virtual

Reimplemented in path_track.

GetSelfTargetEntity()

path_corner path_corner::GetSelfTargetEntity ( void )

virtual

Reimplemented in path_track.

PathPassTrigger()

void path_corner::PathPassTrigger ( entity activatingEntity, triggermode_t triggerMode )

virtual

Respawn()

void path_corner::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 ncPointTrigger.

Reimplemented in path_track.

Restore()

void path_corner::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 ncEntity.

Reimplemented in path_track.

Save()

void path_corner::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 ncEntity.

Reimplemented in path_track.

Spawned()

void path_corner::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 ncEntity.

SpawnKey()

void path_corner::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 ncEntity.

Reimplemented in path_track.

Trigger()

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

virtual

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

Reimplemented from ncTrigger.

Reimplemented in path_track.

---

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

• src/gs-entbase/server/path_corner.qc