func_rot_button Class Reference

About this class

Server-Entity: Valve, Lever, Rotating Button.

QUAKED func_rot_button (0 .5 .8) ? NONSOLID REVERSE x x x NOAUTORETURN XAXIS YAXIS TOUCHABLE

OVERVIEW

A button that rotates along a pivot point. Used for valves, spigots and alike.

KEYS

• "targetname" : Name
• "target" : Name of the entity to trigger when opened
• "speed" : How fast the button turns when activated.
• "health" : If non-zero, the button must be damaged to turn.
• "wait" : Time until the button turns back. A value of -1 makes it stay static.
• "distance" : Distance in degrees the button will rotate.

SPAWNFLAGS

• NONSOLID (1) : Button won't have collision.
• REVERSE (2) : Rotates counter-clockwise.
• NOAUTORETURN (32) : Will not return by itself.
• XAXIS (64) : Rotate along the X-axis.
• YAXIS (128) : Rotate along the Y-axis.

NOTES

Please include an origin brush so that a pivot point will be defined.

TRIVIA

This entity was introduced in Half-Life (1998).

Inheritance diagram for func_rot_button:

Public Member Functions
void	func_rot_button (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	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	Touch (entity)
	Called whenever we're touching another entity.
virtual void	Death (entity, entity, int, vector, vector, int)
	Called when the health is equal or below 0.
virtual void	OnPlayerUse (void)
nonvirtual void	ArrivedClosed (void)
nonvirtual void	ArrivedOpened (void)
nonvirtual void	TriggerTargets (void)
nonvirtual void	Rotate (vector, void())
nonvirtual void	TurnToggle (void)

Constructor & Destructor Documentation

func_rot_button()

void func_rot_button::func_rot_button

(

void

)

Member Function Documentation

ArrivedClosed()

void func_rot_button::ArrivedClosed

(

void

)

ArrivedOpened()

void func_rot_button::ArrivedOpened

(

void

)

Death()

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

OnPlayerUse()

void func_rot_button::OnPlayerUse ( void )

virtual

Respawn()

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

Restore()

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

Rotate()

void func_rot_button::Rotate	(	vector	,
		void()	)

Save()

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

SpawnKey()

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

Touch()

void func_rot_button::Touch ( entity eToucher )

virtual

Called whenever we're touching another entity.

Reimplemented from ncTrigger.

TriggerTargets()

void func_rot_button::TriggerTargets

(

void

)

TurnToggle()

void func_rot_button::TurnToggle

(

void

)

---

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

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