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

About this class

Nav Hint.

QUAKED ncNavHint (0 0 0) (-8 -8 -8) (8 8 8)

OVERVIEW

Helper entity for the Nav routines. Defines where to go for sensible defense/offensive or other hints.

KEYS

  • "targetname" : Name
  • "hintType" : Hint type, this controls this hints' purpose. Be short and descriptive.
  • "hintActivity" : Associated animation activity. Once an NPC goes to this node they'll play it
  • "nodeFOV" : Field of view of the node. You'll probably want to set a sensible angle too.
  • "StartHintDisabled" : Whether or not to 'hide' the hint on start, requiring activation to work.
  • "Group" : Hint group definition. Some NPCs are set up to only look for their specific group.
  • "IgnoreFacing" : Whether or not we need to ignore the angle and field of view setting, see notes.
  • "mindsetFilter" : Comma-separated list of mindsets required to use this hint, see notes.

The 'IgnoreFacing' field can be one of 3 values:

  • NO = 0
  • YES = 1
  • AUTO = 2
Inheritance diagram for ncHint:
ncPointTrigger info_hint

Public Member Functions

void ncHint (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 SpawnKey (string, string)
 This method handles entity key/value pairs on map load. More...
 
virtual void Spawned (void)
 Called when the entity is fulled initialized. More...
 

Constructor & Destructor Documentation

◆ ncHint()

void ncHint::ncHint ( void  )

Member Function Documentation

◆ Restore()

void ncHint::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 ncEntity.

Reimplemented in info_hint.

◆ Save()

void ncHint::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 ncEntity.

Reimplemented in info_hint.

◆ Spawned()

void ncHint::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 ncEntity.

Reimplemented in info_hint.

◆ SpawnKey()

void ncHint::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 ncIO.

Reimplemented from ncEntity.

Reimplemented in info_hint.


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