Nuclide
Software Development Kit for id Tech
Public Member Functions | List of all members
NSMomentary Class Reference

This entity class represents momentary entities. More...

Inheritance diagram for NSMomentary:
NSRenderableEntity momentary_door momentary_rot_button

Public Member Functions

void NSMomentary (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 SetMoveState (int)
 Sets the movement state of the momentary object. More...
 
virtual void MovementStateChanged (void)
 Called whenever the movement state changes. More...
 
virtual float GetProgress (void)
 Returns the progress of the momentary, which is a value between 0.0 and 1.0. More...
 

Detailed Description

This entity class represents momentary entities.

Constructor & Destructor Documentation

◆ NSMomentary()

void NSMomentary::NSMomentary ( void  )

Member Function Documentation

◆ GetProgress()

float NSMomentary::GetProgress ( void  )
virtual

Returns the progress of the momentary, which is a value between 0.0 and 1.0.

Reimplemented in momentary_door, and momentary_rot_button.

◆ MovementStateChanged()

void NSMomentary::MovementStateChanged ( void  )
virtual

Called whenever the movement state changes.

Reimplemented in momentary_door, and momentary_rot_button.

◆ Restore()

void NSMomentary::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 NSRenderableEntity.

Reimplemented in momentary_rot_button.

◆ Save()

void NSMomentary::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 NSRenderableEntity.

Reimplemented in momentary_rot_button.

◆ SetMoveState()

void NSMomentary::SetMoveState ( int  status)
virtual

Sets the movement state of the momentary object.

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