Nuclide
Software Development Kit for id Technology (BETA)
ncMomentary Class Reference

About this class

This entity class represents momentary entities.

Inheritance diagram for ncMomentary:
ncRenderableEntity momentary_door momentary_rot_button

Public Member Functions

void ncMomentary (void)
 
virtual void Save (float)
 Handles saving a copy of this entity to a given filehandle. More...
 
virtual void Restore (string, string)
 Similar to ncIO::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...
 

Constructor & Destructor Documentation

◆ ncMomentary()

void ncMomentary::ncMomentary ( void  )

Member Function Documentation

◆ GetProgress()

float ncMomentary::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 ncMomentary::MovementStateChanged ( void  )
virtual

Called whenever the movement state changes.

Reimplemented in momentary_door, and momentary_rot_button.

◆ Restore()

void ncMomentary::Restore ( string  strKey,
string  strValue 
)
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.

Reimplemented in momentary_rot_button.

◆ Save()

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

Reimplemented in momentary_rot_button.

◆ SetMoveState()

void ncMomentary::SetMoveState ( int  status)
virtual

Sets the movement state of the momentary object.


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