Nuclide
Software Development Kit for id Tech
point_camera Class Reference

Server-Entity: Rendertarget Camera Viewpoint. More...

Inheritance diagram for point_camera:
NSPointTrigger

Public Member Functions

void point_camera (void)
 
virtual void Save (float)
 Handles saving a copy of this entity to a given filehandle. More...
 
virtual void Restore (string, string)
 Similar to NSIO::SpawnKey but for save-game fields. More...
 
virtual void SpawnKey (string, string)
 This method handles entity key/value pairs on map load. More...
 
virtual void Input (entity, string, string)
 Called when we are being prompted by another object/function with an input message. More...
 

Detailed Description

Server-Entity: Rendertarget Camera Viewpoint.

QUAKED point_camera (1 0 0) (-8 -8 -8) (8 8 8) PCAMFL_STARTOFF

OVERVIEW

A virtual camera of which its output can be displayed on a rendertarget. This plays well with the func_monitor entity.

KEYS

  • "targetname" : Name
  • "FOV" : Field of view in degrees
  • "UseScreenAspectRatio" : Forces the aspect ratio to be the same as the game's.
  • "fogEnable" : Enable fog in the camera's view.
  • "fogColor" : Color of the fog in RGB255.
  • "fogStart" : Near fog plane.
  • "fogEnd" : Far fog plane.

INPUTS

  • "ChangeFOV" : Change the camera's field of view.
  • "SetOnAndTurnOthersOff" : Turn this camera on while deactivating all others.
  • "SetOn" : Turn this camera on.
  • "SetOff" : Turn this camera off.

SPAWNFLAGS

  • PCAMFL_STARTOFF (1) : Start with the camera turned off, outputting no signal.

TRIVIA

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

Constructor & Destructor Documentation

◆ point_camera()

void point_camera::point_camera ( void  )

Member Function Documentation

◆ Input()

void point_camera::Input ( entity  eAct,
string  strInput,
string  strData 
)
virtual

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

Reimplemented from NSEntity.

◆ Restore()

void point_camera::Restore ( string  strKey,
string  strValue 
)
virtual

Similar to NSIO::SpawnKey but for save-game fields.

Whatever you write into file handles within your NSIO::Save() method needs to be read back in here.

Reimplemented from NSPointTrigger.

◆ Save()

void point_camera::Save ( float  handle)
virtual

Handles saving a copy of this entity to a given filehandle.

Within you want to use the NSIO::SaveFloat() etc. methods to write the internal member attributes to the specified file handle.

Reimplemented from NSPointTrigger.

◆ SpawnKey()

void point_camera::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 NSPointTrigger.


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