Nuclide
Software Development Kit for id Technology
NSAttack Class Reference

About this class

This entity class represents an attack.

Usually spawned by a decl's fireInfo properties.

Inheritance diagram for NSAttack:
NSSurfacePropEntity NSProjectile

Public Member Functions

void NSAttack (void)
 
virtual void Spawned (void)
 Called when the entity is fulled initialized. More...
 
virtual void SpawnKey (string, string)
 This method handles entity key/value pairs on map load. More...
 
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 Launch (vector, vector, float, float, float)
 
nonvirtual void SetWeaponOwner (NSWeapon)
 
nonvirtual NSWeapon GetWeaponOwner (void)
 

Constructor & Destructor Documentation

◆ NSAttack()

void NSAttack::NSAttack ( void  )

Member Function Documentation

◆ GetWeaponOwner()

NSWeapon NSAttack::GetWeaponOwner ( void  )

◆ Launch()

void NSAttack::Launch ( vector  startPos,
vector  launchDir,
float  fuseOffset,
float  powerMultiplier,
float  dmgMultiplier 
)
virtual

Reimplemented in NSProjectile.

◆ Restore()

void NSAttack::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 NSSurfacePropEntity.

Reimplemented in NSProjectile.

◆ Save()

void NSAttack::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 NSSurfacePropEntity.

Reimplemented in NSProjectile.

◆ SetWeaponOwner()

void NSAttack::SetWeaponOwner ( NSWeapon  weaponOwner)

◆ Spawned()

void NSAttack::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 NSSurfacePropEntity.

Reimplemented in NSProjectile.

◆ SpawnKey()

void NSAttack::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 NSSurfacePropEntity.

Reimplemented in NSProjectile.


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