env_funnel Class Reference

About this class

Shared-Entity: Funneling Sprite Controller.

QUAKED env_funnel (1 .5 0) (-8 -8 -8) (8 8 8) REVERSE REPEATABLE

OVERVIEW

An effect that when triggered, will create lots of glowing orbs that funnel into the position of this entity.

KEYS

• "targetname" : Name
• "sprite" : Particle sprite path.

SPAWNFLAGS

• REVERSE (1) : Will play the effect in reverse.
• REPEATABLE (2) : Will allow you to trigger the effect multiple times.

TRIVIA

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

Inheritance diagram for env_funnel:

Public Member Functions
void	env_funnel (void)
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	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	EvaluateEntity (void)
	Run each tic after physics are run to determine if we need to send updates over the network.
virtual float	SendEntity (entity, float)
	Called by the engine whenever we need to send a client an update about this entity.
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 float	predraw (void)
virtual void	ReceiveEntity (float, float)
	Client: Handles network updates from the server for the associated entity.
virtual void	ReloadVideoResources (void)
	Client: Called when video resources need to be allocated or reloaded for the entity.
nonvirtual void	RenderGlow (vector, vector, float)

Constructor & Destructor Documentation

env_funnel()

void env_funnel::env_funnel

(

void

)

Member Function Documentation

EvaluateEntity()

void env_funnel::EvaluateEntity ( void )

virtual

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

Reimplemented from ncRenderableEntity.

Input()

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

virtual

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

Reimplemented from ncRenderableEntity.

predraw()

float env_funnel::predraw ( void )

virtual

Reimplemented from ncRenderableEntity.

ReceiveEntity()

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

virtual

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

Reimplemented from ncRenderableEntity.

ReloadVideoResources()

void env_funnel::ReloadVideoResources ( void )

virtual

Client: Called when video resources need to be allocated or reloaded for the entity.

Reimplemented from ncRenderableEntity.

RenderGlow()

void env_funnel::RenderGlow	(	vector	forg,
		vector	fsize,
		float	amount )

Respawn()

void env_funnel::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 ncRenderableEntity.

Restore()

void env_funnel::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 ncRenderableEntity.

Save()

void env_funnel::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 ncRenderableEntity.

SendEntity()

float env_funnel::SendEntity ( entity , float  )

virtual

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

Reimplemented from ncRenderableEntity.

SpawnKey()

void env_funnel::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 ncRenderableEntity.

Trigger()

void env_funnel::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 file:

• src/gs-entbase/shared/env_funnel.qc