FB2AuraComponent

Overview

• Component that manages auras (area effects).

Metadata

Field	Value
Kind	component
Environment	B2 - Simulation
Category	components
Extends	FB2Component
Require	require('Components.B2AuraComponent')

Properties (6)

Name	Type	Description
ActiveEmittedAuraIds	table<string, boolean>	List of Auras I am directly emitting (keyed by AuraId).
ActiveEmittedAuras	table<string, any>
ActiveReceivedAuraIds	table<string, boolean>	List of Auras whose effects I am currently receiving (stores only AuraId).
LastAuraFloorLevel	integer
PendingAuraApplies	table<string, FB1AuraKey>	Deferred-apply queue for Aura propagation.
PendingAuraRemovals	table<string, FB1AuraKey>

Functions (11)

Function	Parameters	Returns	Description
EmitAura	InAuraId: string	-
GetActiveEmittedAura	Self: FB2AuraComponent, AuraId: string	-	Returns Active Emitted Aura.
GetDefaultCityMoveDataPolicy	-	EB1CityMoveDataPolicy	Returns Default City Move Data Policy.
GetLastAuraFloorLevel	-	integer	Returns Last Aura Floor Level.
GetType	-	EB2ComponentType	Returns Type.
HasPendingAura	-	boolean	Returns whether it has Pending Aura.
OnEnterAura	InAuraKey: FB1AuraKey	-	Callback invoked on Enter Aura.
OnExitAura	InAuraKey: FB1AuraKey	-	Callback invoked on Exit Aura.
ProcessQueueAura	-	-	Made public to be callable from B2AuraSystem.
SetLastAuraFloorLevel	InFloorLevel: integer	-	Sets Last Aura Floor Level.
WithdrawAura	InAuraId: string	-	Removes an external Aura effect.

Override points (4)

Implement these in Lua as FB2AuraComponent.Override_Name = function(...) end.

Function	Parameters	Returns	Description
Override_EmitAura	InAuraId: string	-
Override_OnEnterAura	InAuraKey: FB1AuraKey	-	Callback invoked on Enter Aura.
Override_OnExitAura	InAuraKey: FB1AuraKey	-	Callback invoked on Exit Aura.
Override_WithdrawAura	InAuraId: string	-	Removes an external Aura effect.