env_sun Class Reference

About this class

Client-Entity: Sun Flare Controller.

QUAKED env_sun (1 .5 0) (-8 -8 -8) (8 8 8)

OVERVIEW

Visual representation of where the sun is positioned in the sky.

KEYS

• "targetname" : Name
• "pitch" : Sun glow pitch.
• "angle" : Sun glow angle.
• "use_angles" : Use the 'angles' yaw value instead of the one from 'angle'.

TRIVIA

This entity was introduced in Half-Life 2 (2004).

Inheritance diagram for env_sun:

Public Member Functions
void	env_sun (void)
virtual void	Spawned (void)
	Called when the entity is fulled initialized. More...
virtual void	postdraw (void)
	Client: Run after the rendering of 3D world is complete. More...
virtual float	predraw (void)
virtual void	SpawnKey (string, string)
	This method handles entity key/value pairs on map load. More...
virtual void	RendererRestarted (void)
	Client: Called when video resources need to be allocated or reloaded for the entity. More...
virtual bool	CanSpawn (bool)
	Returns if this entity can spawned from the map file. More...

Constructor & Destructor Documentation

env_sun()

void env_sun::env_sun

(

void

)

Member Function Documentation

CanSpawn()

bool env_sun::CanSpawn ( bool  clientSide )

virtual

Returns if this entity can spawned from the map file.

Parameters

clientSide

If it's being spawned on the client-side.

Reimplemented from NSEntity.

postdraw()

void env_sun::postdraw ( void  )

virtual

Client: Run after the rendering of 3D world is complete.

2D calls can happen here.

Reimplemented from NSEntity.

predraw()

float env_sun::predraw ( void  )

virtual

Reimplemented from NSEntity.

RendererRestarted()

void env_sun::RendererRestarted ( void  )

virtual

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

Reimplemented from NSEntity.

Spawned()

void env_sun::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 NSEntity.

SpawnKey()

void env_sun::SpawnKey ( string  strKey, string  strValue  )

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

Reimplemented from NSEntity.

---

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

• src/gs-entbase/client/env_sun.qc