Buff Class Reference

Inheritance diagram for Buff:

Public Member Functions
void	Refresh (float str, float dur)
	Change the buff's strength value. More...
void	Deactivate ()
	Deactivate the buff. More...
void	Activate ()
	Activate the buff. More...
virtual void	OnActivate ()
	Function called when the buff has been activated. More...
virtual void	OnDeactivate ()
	Function called when the buff has been deactivated. More...
Public Member Functions inherited from TNBehaviour
virtual void	DestroySelf ()
	Destroy this game object. More...

Public Attributes
float	strength = 0f
float	duration = -1f
GameUnit	source
	Unit that created this buff. Used to give credit for kills. More...
Public Attributes inherited from Attachable
PlayerItem	item
	When an Attachable is added to the unit, this field will contain the item that added it. More...

Protected Member Functions
override void	Awake ()
override void	OnEnable ()
virtual void	Start ()
virtual void	OnNotify (HUDText hud, bool isActive)
	Show a notification above the unit that they've gained or lost this buff. More...
virtual void	OnUpdate ()
	Function called on Update while the buff is active. More...

Protected Attributes
GameShip	mShip
bool	mActive = false
bool	mStarted = false
Protected Attributes inherited from Attachable
GameUnit	mUnit

Properties
bool	isActive [get]
	Whether the buff is currently active or not. More...
virtual string	notificationText [get]
	Text shown when the buff gets activated. If 'null' is returned, nothing will be shown. More...
Properties inherited from Attachable
GameUnit	unit [get]
	Unit this attachable belongs to. More...
Properties inherited from TNBehaviour
TNObject	tno [get]

Member Function Documentation

void Buff.Activate

(

)

Activate the buff.

override void Buff.Awake ( )

protectedvirtual

Reimplemented from Attachable.

void Buff.Deactivate

(

)

Deactivate the buff.

virtual void Buff.OnActivate ( )

virtual

Function called when the buff has been activated.

Reimplemented in BuffUtility, BuffDef1, BuffOff1, BuffDef0, BuffSup1, BuffStat, DebuffDefense, BuffDeflect, BuffImprove, BuffDamage, BuffHaste, BuffHull, BuffRegenPenalty, BuffInferno, BuffPoison, BuffBlackFlag, BuffDefense, BuffFog, and BuffWhiteFlag.

virtual void Buff.OnDeactivate ( )

virtual

Function called when the buff has been deactivated.

Reimplemented in BuffPoison, BuffImprove, BuffUtility, BuffDef1, BuffOff1, BuffDef0, BuffStat, BuffSup1, BuffInferno, BuffBlackFlag, DebuffDefense, BuffDeflect, BuffHaste, BuffWhiteFlag, BuffDamage, BuffHull, BuffRegenPenalty, BuffFog, and BuffDefense.

override void Buff.OnEnable ( )

protectedvirtual

Reimplemented from TNBehaviour.

virtual void Buff.OnNotify ( HUDText  hud, bool  isActive  )

protectedvirtual

Show a notification above the unit that they've gained or lost this buff.

virtual void Buff.OnUpdate ( )

protectedvirtual

Function called on Update while the buff is active.

Reimplemented in BuffImprove.

void Buff.Refresh	(	float	str,
		float	dur
	)

Change the buff's strength value.

virtual void Buff.Start ( )

protectedvirtual

Member Data Documentation

float Buff.duration = -1f

bool Buff.mActive = false

protected

GameShip Buff.mShip

protected

bool Buff.mStarted = false

protected

GameUnit Buff.source

Unit that created this buff. Used to give credit for kills.

float Buff.strength = 0f

Property Documentation

bool Buff.isActive

get

Whether the buff is currently active or not.

virtual string Buff.notificationText

getprotected

Text shown when the buff gets activated. If 'null' is returned, nothing will be shown.

---

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

• Game/Scripts/Buffs/Buff.cs