func_plat Class Reference

About this class

Server-Entity: Automatic Elevator.

QUAKED func_plat (0 .5 .8) ? FNCPLAT_TRIGGER

OVERVIEW

It's a simple elevator. It goes down... and back up.

KEYS

• "targetname" : Name
• "speed" : Speed of the lift in units per second
• "height" : Number of units the lift is supposed to move down

SPAWNFLAGS

• FNCPLAT_TRIGGER (1) : Has to be triggered to move.

NOTES

By default, touching the platform near its end/start point results in the platform to be called up/down.

TRIVIA

This entity was introduced in Quake (1996).

Inheritance diagram for func_plat:

Public Member Functions
void	func_plat (void)
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	Trigger (entity, triggermode_t)
	Called whenever we're legacy triggered by another object or function.
virtual void	Input (entity, string, string)
	Called when we are being prompted by another object/function with an input message.
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	SpawnKey (string, string)
	This method handles entity key/value pairs on map load.
virtual void	Spawned (void)
	Called when the entity is fulled initialized.
virtual void	MoverStartsMoving (void)
	Overridable: Called when the mover starts moving from its position to another.
virtual void	MoverFinishesMoving (void)
	Overridable: Called when the mover completes its movement to a destination.
virtual void	PlatformReturn (void)
nonvirtual float	GetPlatformHeight (void)
nonvirtual float	GetPlatformSpeed (void)

Constructor & Destructor Documentation

func_plat()

void func_plat::func_plat

(

void

)

Member Function Documentation

GetPlatformHeight()

float func_plat::GetPlatformHeight

(

void

)

GetPlatformSpeed()

float func_plat::GetPlatformSpeed

(

void

)

Input()

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

MoverFinishesMoving()

void func_plat::MoverFinishesMoving ( void )

virtual

Overridable: Called when the mover completes its movement to a destination.

Reimplemented from ncMoverEntity.

Reimplemented in func_trackchange.

MoverStartsMoving()

void func_plat::MoverStartsMoving ( void )

virtual

Overridable: Called when the mover starts moving from its position to another.

Reimplemented from ncMoverEntity.

Reimplemented in func_trackchange.

PlatformReturn()

void func_plat::PlatformReturn ( void )

virtual

Reimplemented in func_platrot.

Respawn()

void func_plat::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 func_platrot.

Restore()

void func_plat::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 ncMoverEntity.

Reimplemented in func_platrot, and func_trackchange.

Save()

void func_plat::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 ncMoverEntity.

Reimplemented in func_platrot, and func_trackchange.

Spawned()

void func_plat::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 func_trackchange.

SpawnKey()

void func_plat::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 ncMoverEntity.

Reimplemented in func_platrot, and func_trackchange.

Trigger()

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

virtual

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

Reimplemented from ncTrigger.

Reimplemented in func_platrot.

---

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

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