EffectArea Class Reference

Private Member Functions
void	EffectArea ()
void	~EffectArea ()
void	SetupZoneData (EffectAreaParams params)
void	Tick ()
override void	OnCEUpdate ()
void	InitZone ()
void	InitZoneServer ()
void	InitZoneClient ()
override bool	CanPutInCargo (EntityAI parent)
override bool	CanPutIntoHands (EntityAI parent)
override bool	DisableVicinityIcon ()
override bool	CanBeTargetedByAI (EntityAI ai)
void	PlaceParticles (vector pos, float radius, int nbRings, int innerSpacing, bool outerToggle, int outerSpacing, int outerOffset, int partId)
void	OnParticleAllocation (ParticleManager pm, array< ParticleSource > particles)
int	GetRequesterIndex (string type)
void	CreateTrigger (vector pos, int radius)
override void	EEDelete (EntityAI parent)
void	OnPlayerEnterServer (PlayerBase player, EffectTrigger trigger)
void	OnPlayerExitServer (PlayerBase player, EffectTrigger trigger)

Private Attributes
string	m_Name = "Default setup"
int	m_Type = eZoneType.STATIC
vector	m_Position
float	m_Radius = 100
float	m_PositiveHeight = 25
float	m_NegativeHeight = 10
int	m_InnerRings = 1
int	m_InnerSpacing = 35
bool	m_OuterRingToggle = true
int	m_OuterRingOffset = -5
int	m_OuterSpacing = 20
int	m_VerticalLayers = 0
int	m_VerticalOffset = 10
int	m_ParticleID = ParticleList.CONTAMINATED_AREA_GAS_BIGASS
int	m_AroundParticleID = ParticleList.CONTAMINATED_AREA_GAS_AROUND
int	m_TinyParticleID = ParticleList.CONTAMINATED_AREA_GAS_TINY
string	m_PPERequesterType
int	m_PPERequesterIdx = -1
int	m_EffectsPriority
string	m_TriggerType = "ContaminatedTrigger"
EffectTrigger	m_Trigger
ref array< Particle >	m_ToxicClouds

Constructor & Destructor Documentation

EffectArea()

void EffectArea ( )

inlineprivate

~EffectArea()

void ~EffectArea ( )

inlineprivate

Member Function Documentation

CanBeTargetedByAI()

override bool CanBeTargetedByAI ( EntityAI  ai )

inlineprivate

CanPutInCargo()

override bool CanPutInCargo ( EntityAI  parent )

inlineprivate

CanPutIntoHands()

override bool CanPutIntoHands ( EntityAI  parent )

inlineprivate

CreateTrigger()

void CreateTrigger ( vector  pos, int  radius  )

inlineprivate

References Class::CastTo(), ECE_NONE, GetGame(), EffectTrigger::Init(), m_AroundParticleID, m_EffectsPriority, m_NegativeHeight, m_PositiveHeight, m_PPERequesterIdx, m_TinyParticleID, m_Trigger, m_TriggerType, and EffectTrigger::SetLocalEffects().

DisableVicinityIcon()

override bool DisableVicinityIcon ( )

inlineprivate

EEDelete()

override void EEDelete ( EntityAI  parent )

inlineprivate

References GetGame(), m_ToxicClouds, m_Trigger, and CGame::ObjectDelete().

GetRequesterIndex()

int GetRequesterIndex ( string  type )

inlineprivate

References PPERequesterBase::GetRequesterIDX(), and string::ToType().

Referenced by ContaminatedArea_Dynamic::EEOnCECreate(), and SetupZoneData().

InitZone()

void InitZone ( )

inlineprivate

References GetGame(), InitZoneClient(), InitZoneServer(), and m_Position.

Referenced by SpookyArea::EEInit(), InitZoneClient(), and SetupZoneData().

InitZoneClient()

void InitZoneClient ( )

inlineprivate

Referenced by InitZone().

InitZoneServer()

void InitZoneServer ( )

inlineprivate

Referenced by InitZone().

OnCEUpdate()

override void OnCEUpdate ( )

inlineprivate

References Tick().

OnParticleAllocation()

void OnParticleAllocation ( ParticleManager  pm, array< ParticleSource >  particles  )

inlineprivate

References m_ToxicClouds.

Referenced by PlaceParticles().

OnPlayerEnterServer()

void OnPlayerEnterServer ( PlayerBase  player, EffectTrigger  trigger  )

inlineprivate

OnPlayerExitServer()

void OnPlayerExitServer ( PlayerBase  player, EffectTrigger  trigger  )

inlineprivate

PlaceParticles()

void PlaceParticles ( vector  pos, float  radius, int  nbRings, int  innerSpacing, bool  outerToggle, int  outerSpacing, int  outerOffset, int  partId  )

inlineprivate

References Math::Acos(), Math::Cos(), Error(), ErrorEx, GetGame(), m_Name, m_NegativeHeight, m_PositiveHeight, m_ToxicClouds, m_Type, m_VerticalLayers, m_VerticalOffset, OnParticleAllocation(), ParticleManager(), Math::PI2, vector::RotateAroundZero(), Math::Sin(), Math::SqrInt(), CGame::SurfaceY(), vector::Up, and vector::Zero.

Referenced by ContaminatedArea_Dynamic::InitZoneClient(), and SpookyArea::InitZoneClient().

SetupZoneData()

void SetupZoneData ( EffectAreaParams  params )

inlineprivate

References GetRequesterIndex(), InitZone(), m_AroundParticleID, m_InnerRings, m_InnerSpacing, m_Name, m_NegativeHeight, m_OuterRingOffset, m_OuterRingToggle, m_OuterSpacing, m_ParticleID, m_PositiveHeight, m_PPERequesterIdx, m_PPERequesterType, m_Radius, m_TinyParticleID, m_TriggerType, m_VerticalLayers, and m_VerticalOffset.

Referenced by EffectAreaLoader::CreateZones().

Tick()

void Tick ( )

inlineprivate

Referenced by OnCEUpdate().

Field Documentation

m_AroundParticleID

int m_AroundParticleID = ParticleList.CONTAMINATED_AREA_GAS_AROUND

private

Referenced by ContaminatedArea_Dynamic::CreateTrigger(), CreateTrigger(), and SetupZoneData().

m_EffectsPriority

int m_EffectsPriority

private

Referenced by ContaminatedArea_Local::ContaminatedArea_Local(), and CreateTrigger().

m_InnerRings

int m_InnerRings = 1

private

Referenced by ContaminatedArea_Dynamic::EEInit(), ContaminatedArea_Dynamic::InitZoneClient(), SpookyArea::InitZoneClient(), and SetupZoneData().

m_InnerSpacing

int m_InnerSpacing = 35

private

Referenced by ContaminatedArea_Dynamic::EEInit(), ContaminatedArea_Dynamic::InitZoneClient(), SpookyArea::InitZoneClient(), and SetupZoneData().

m_Name

string m_Name = "Default setup"

private

Referenced by ContaminatedArea_Dynamic::EEInit(), PlaceParticles(), and SetupZoneData().

m_NegativeHeight

float m_NegativeHeight = 10

private

Referenced by CreateTrigger(), ContaminatedArea_Dynamic::EEInit(), PlaceParticles(), and SetupZoneData().

m_OuterRingOffset

int m_OuterRingOffset = -5

private

Referenced by ContaminatedArea_Dynamic::EEInit(), ContaminatedArea_Dynamic::InitZoneClient(), SpookyArea::InitZoneClient(), and SetupZoneData().

m_OuterRingToggle

bool m_OuterRingToggle = true

private

Referenced by ContaminatedArea_Dynamic::InitZoneClient(), SpookyArea::InitZoneClient(), and SetupZoneData().

m_OuterSpacing

int m_OuterSpacing = 20

private

Referenced by ContaminatedArea_Dynamic::EEInit(), ContaminatedArea_Dynamic::InitZoneClient(), SpookyArea::InitZoneClient(), and SetupZoneData().

m_ParticleID

int m_ParticleID = ParticleList.CONTAMINATED_AREA_GAS_BIGASS

private

Referenced by ContaminatedArea_Dynamic::InitZoneClient(), SpookyArea::InitZoneClient(), and SetupZoneData().

m_Position

vector m_Position

private

Referenced by InitZone(), ContaminatedArea_Dynamic::InitZoneServer(), SpookyArea::InitZoneServer(), and ContaminatedArea_Dynamic::SpawnItems().

m_PositiveHeight

float m_PositiveHeight = 25

private

Referenced by CreateTrigger(), ContaminatedArea_Dynamic::EEInit(), PlaceParticles(), and SetupZoneData().

m_PPERequesterIdx

int m_PPERequesterIdx = -1

private

Referenced by ContaminatedArea_Dynamic::CreateTrigger(), CreateTrigger(), ContaminatedArea_Dynamic::EEOnCECreate(), and SetupZoneData().

m_PPERequesterType

string m_PPERequesterType

private

Referenced by ContaminatedArea_Dynamic::EEOnCECreate(), and SetupZoneData().

m_Radius

float m_Radius = 100

private

Referenced by ContaminatedArea_Dynamic::EEInit(), ContaminatedArea_Base::InitZoneClient(), ContaminatedArea_Dynamic::InitZoneClient(), SpookyArea::InitZoneClient(), ContaminatedArea_Dynamic::InitZoneServer(), SpookyArea::InitZoneServer(), and SetupZoneData().

m_TinyParticleID

int m_TinyParticleID = ParticleList.CONTAMINATED_AREA_GAS_TINY

private

Referenced by ContaminatedArea_Dynamic::CreateTrigger(), CreateTrigger(), and SetupZoneData().

m_ToxicClouds

ref array<Particle> m_ToxicClouds

private

Referenced by EEDelete(), ContaminatedArea_Dynamic::EEInit(), SpookyArea::EEInit(), ContaminatedArea_Dynamic::InitZoneClient(), OnParticleAllocation(), ContaminatedArea_Dynamic::OnVariablesSynchronized(), and PlaceParticles().

m_Trigger

EffectTrigger m_Trigger

private

Referenced by ContaminatedArea_Dynamic::CreateTrigger(), CreateTrigger(), EEDelete(), and ContaminatedArea_Dynamic::SetDecayState().

m_TriggerType

string m_TriggerType = "ContaminatedTrigger"

private

Referenced by CreateTrigger(), ContaminatedArea_Dynamic::EEInit(), ContaminatedArea_Dynamic::InitZoneServer(), SpookyArea::InitZoneServer(), and SetupZoneData().

m_Type

int m_Type = eZoneType.STATIC

private

Referenced by ContaminatedArea_Dynamic::EEInit(), and PlaceParticles().

m_VerticalLayers

int m_VerticalLayers = 0

private

Referenced by PlaceParticles(), and SetupZoneData().

m_VerticalOffset

int m_VerticalOffset = 10

private

Referenced by PlaceParticles(), and SetupZoneData().

---

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

• P:/scripts/4_World/Classes/ContaminatedArea/EffectArea.c