Inheritance diagram for EffectArea:

Collaboration diagram for EffectArea:

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

Detailed Description

Definition at line 36 of file EffectArea.c.

Constructor & Destructor Documentation

◆ EffectArea()

void EffectArea::EffectArea ( )

inlineprivate

Definition at line 79 of file EffectArea.c.

  {
    RegisterNetSyncVariableFloat("m_Radius", 0, 0, 2);
    RegisterNetSyncVariableFloat("m_PositiveHeight", 0, 0, 2);
    RegisterNetSyncVariableFloat("m_NegativeHeight", 0, 0, 2);
 
    RegisterNetSyncVariableInt("m_InnerRings");
    RegisterNetSyncVariableInt("m_InnerSpacing");
    RegisterNetSyncVariableInt("m_OuterRingOffset");
    RegisterNetSyncVariableInt("m_OuterSpacing");
    RegisterNetSyncVariableInt("m_VerticalLayers");
    RegisterNetSyncVariableInt("m_VerticalOffset");
 
    RegisterNetSyncVariableInt("m_ParticleID");
    /*
      RegisterNetSyncVariableInt("m_AroundParticleID");
      RegisterNetSyncVariableInt("m_TinyParticleID");
      RegisterNetSyncVariableInt("m_PPERequesterIdx");
    */
    RegisterNetSyncVariableBool("m_OuterRingToggle");
  }

◆ ~EffectArea()

void EffectArea::~EffectArea ( )

inlineprivate

Definition at line 101 of file EffectArea.c.

  {
 
  }

Member Function Documentation

◆ CanBeTargetedByAI()

override bool EffectArea::CanBeTargetedByAI ( EntityAI ai )

inlineprivate

Definition at line 209 of file EffectArea.c.

  {
    return false;
  }

◆ CanPutInCargo()

override bool EffectArea::CanPutInCargo ( EntityAI parent )

inlineprivate

Definition at line 194 of file EffectArea.c.

  {
    return false;
  }

◆ CanPutIntoHands()

override bool EffectArea::CanPutIntoHands ( EntityAI parent )

inlineprivate

Definition at line 199 of file EffectArea.c.

  {
    return false;
  }

◆ CreateTrigger()

void EffectArea::CreateTrigger	(	vector	pos,
		int	radius )

inlineprivate

Definition at line 391 of file EffectArea.c.

  {
    // The trigger pos is based on lwer end, but we want to stretch downwards
    pos[1] = pos[1] - m_NegativeHeight;
 
    // Create new trigger of specified type
    if (Class.CastTo(m_Trigger, GetGame().CreateObjectEx(m_TriggerType, pos, ECE_NONE)))
    {
      // We finalize trigger dimension setup
      m_Trigger.SetCollisionCylinder(radius, (m_NegativeHeight + m_PositiveHeight));
 
      // If the trigger is lower in hierarchy and can see it's local effects customized, we pass the new parameters
      if (m_Trigger.IsInherited(EffectTrigger))
      {
        //Debug.Log("We override area local effects");
        EffectTrigger.Cast(m_Trigger).SetLocalEffects(m_AroundParticleID, m_TinyParticleID, m_PPERequesterIdx);
      }
      m_Trigger.Init(this, m_EffectsPriority);
      //Debug.Log("We created the trigger at : " + m_Trigger.GetWorldPosition() );
    }
  }

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 EffectArea::DisableVicinityIcon ( )

inlineprivate

Definition at line 204 of file EffectArea.c.

  {
    return true;
  }

◆ EEDelete()

override void EffectArea::EEDelete ( EntityAI parent )

inlineprivate

Definition at line 417 of file EffectArea.c.

  {
    if (m_Trigger)
      GetGame().ObjectDelete(m_Trigger);
 
    // We stop playing particles on this client when the base object is deleted ( out of range for example )
    if ((GetGame().IsClient() || !GetGame().IsMultiplayer()) && m_ToxicClouds)
    {
      foreach (Particle p : m_ToxicClouds)
        p.Stop();
    }
 
    super.EEDelete(parent);
  }

References GetGame(), m_ToxicClouds, and m_Trigger.

◆ GetRequesterIndex()

int EffectArea::GetRequesterIndex ( string type )

inlineprivate

Definition at line 375 of file EffectArea.c.

  {
    typename t = type.ToType();
    if (!t)
      return - 1;
    PPERequesterBase req = PPERequesterBank.GetRequester(t);
    if (req)
      return req.GetRequesterIDX();
    return -1;
  }

References string::ToType().

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

◆ InitZone()

void EffectArea::InitZone ( )

inlineprivate

Definition at line 168 of file EffectArea.c.

  {
    //Debug.Log("------------------------------------------");
    //Debug.Log( "We have created the zone : " + m_Name );
 
    m_Position = GetWorldPosition();
 
    if (!GetGame().IsDedicatedServer())
      InitZoneClient();
 
    if (GetGame().IsServer())
      InitZoneServer();
 
    //Debug.Log("------------------------------------------");
  }

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

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

◆ InitZoneClient()

void EffectArea::InitZoneClient ( )

inlineprivate

Definition at line 188 of file EffectArea.c.

188{};

Referenced by InitZone().

◆ InitZoneServer()

void EffectArea::InitZoneServer ( )

inlineprivate

Definition at line 186 of file EffectArea.c.

186{};

Referenced by InitZone().

◆ OnCEUpdate()

override void EffectArea::OnCEUpdate ( )

inlineprivate

Definition at line 162 of file EffectArea.c.

  {
    super.OnCEUpdate();
    Tick();
  }

References Tick().

◆ OnParticleAllocation()

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

inlineprivate

Definition at line 366 of file EffectArea.c.

  {
    foreach (ParticleSource p : particles)
    {
      if (p.GetOwner() == this) // Safety, since it can be unrelated particles when done through event
        m_ToxicClouds.Insert(p);
    }
  }

References m_ToxicClouds.

Referenced by PlaceParticles().

◆ OnPlayerEnterServer()

void EffectArea::OnPlayerEnterServer	(	PlayerBase	player,
		EffectTrigger	trigger )

inlineprivate

Definition at line 432 of file EffectArea.c.

  {
    player.IncreaseEffectAreaCount();
  }

◆ OnPlayerExitServer()

void EffectArea::OnPlayerExitServer	(	PlayerBase	player,
		EffectTrigger	trigger )

inlineprivate

Definition at line 436 of file EffectArea.c.

  {
    player.DecreaseEffectAreaCount();
  }

◆ PlaceParticles()

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

inlineprivate

Definition at line 218 of file EffectArea.c.

  {
#ifdef NO_GUI
    return; // do not place any particles if there is no GUI
#endif
    if (partId == 0)
    {
      Error("[WARNING] :: [EffectArea PlaceParticles] :: no particle defined, skipping area particle generation");
      return;
    }
    // Determine if we snap first layer to ground
    bool snapFirstLayer = true;
    if (m_Type == eZoneType.STATIC && pos[1] != GetGame().SurfaceRoadY(pos[0], pos[2]))
      snapFirstLayer = false;
 
    // BEGINNING OF SAFETY NET
    // We want to prevent divisions by 0
    if (radius == 0)
    {
      // In specific case of radius, we log an error and return as it makes no sense
      Error("[WARNING] :: [EffectArea PlaceParticles] :: Radius of contaminated zone is set to 0, this should not happen");
      return;
    }
 
    if (outerToggle && radius == outerOffset)
    {
      Error("[WARNING] :: [EffectArea PlaceParticles] :: Your outerOffset is EQUAL to your Radius, this will result in division by 0");
      return;
    }
 
    // Inner spacing of 0 would cause infinite loops as no increment would happen
    if (innerSpacing == 0)
      innerSpacing = 1;
 
    // END OF SAFETY NET
 
    int partCounter = 0; // Used for debugging, allows one to know how many emitters are spawned in zone
    int numberOfEmitters = 1; // We always have the central emitter
 
    //Debug.Log("We have : " + nbRings + " rings");
    //Debug.Log("We have : " + m_VerticalLayers + " layers");
 
    float angle = 0; // Used in for loop to know where we are in terms of angle spacing ( RADIANS )
 
    ParticlePropertiesArray props = new ParticlePropertiesArray();
 
    // We also populate vertically, layer 0 will be snapped to ground, subsequent layers will see particles floating and relevant m_VerticalOffset
    for (int k = 0; k <= m_VerticalLayers; k++)
    {
      vector partPos = pos;
      // We prevent division by 0
      // We don't want to tamper with ground layer vertical positioning
      if (k != 0)
        partPos[1] = partPos[1] + (m_VerticalOffset * k);
 
      // We will want to start by placing a particle at center of area
      props.Insert(ParticleProperties(partPos, ParticlePropertiesFlags.PLAY_ON_CREATION, null, vector.Zero, this));
      partCounter++;
 
      // For each concentric ring, we place a particle emitter at a set offset
      for (int i = 1; i <= nbRings + outerToggle; i++)
      {
        //Debug.Log("We are on iteration I : " + i );
 
        // We prepare the variables to use later in calculation
        float angleIncrement; // The value added to the offset angle to place following particle
        float ab; // Length of a side of triangle used to calculate particle positionning
        vector temp = vector.Zero; // Vector we rotate to position next spawn point
 
        // The particle density is not the same on the final ring which will only happen if toggled
        // Toggle uses bool parameter treated as int, thus i > nbRings test ( allows to limit branching )
        if (i > nbRings)
        {
          ab = radius - outerOffset; // We want to leave some space to better see area demarcation
 
          // We calculate the rotation angle depending on particle spacing and distance from center
          angleIncrement = Math.Acos(1 - ((outerSpacing * outerSpacing) / (2 * Math.SqrInt(ab))));
          temp[2] = temp[2] + ab;
 
          //Debug.Log("Radius of last circle " + i + " is : " + ab);
        }
        else
        {
          ab = (radius / (nbRings + 1)) * i; // We add the offset from one ring to another
 
          // We calculate the rotation angle depending on particle spacing and distance from center
          angleIncrement = Math.Acos(1 - ((innerSpacing * innerSpacing) / (2 * Math.SqrInt(ab))));
          temp[2] = temp[2] + ab;
 
          //Debug.Log("Radius of inner circle " + i + " is : " + ab);
        }
 
        for (int j = 0; j <= (Math.PI2 / angleIncrement); j++)
        {
          // Determine position of particle emitter
          // Use offset of current ring for vector length
          // Use accumulated angle for vector direction
 
          float sinAngle = Math.Sin(angle);
          float cosAngle = Math.Cos(angle);
 
          partPos = vector.RotateAroundZero(temp, vector.Up, cosAngle, sinAngle);
          partPos += pos;
 
          // We snap first layer to ground if specified
          if (k == 0 && snapFirstLayer == true)
            partPos[1] = GetGame().SurfaceY(partPos[0], partPos[2]);
          else if (k == 0 && snapFirstLayer == false)
            partPos[1] = partPos[1] - m_NegativeHeight;
 
          // We check the particle is indeed in the trigger to make it consistent
          if (partPos[1] <= pos[1] + m_PositiveHeight && partPos[1] >= pos[1] - m_NegativeHeight)
          {
            // Place emitter at vector end ( coord )
            props.Insert(ParticleProperties(partPos, ParticlePropertiesFlags.PLAY_ON_CREATION, null, GetGame().GetSurfaceOrientation(partPos[0], partPos[2]), this));
 
            ++partCounter;
          }
 
          // Increase accumulated angle
          angle += angleIncrement;
        }
 
        angle = 0; // We reset our accumulated angle for the next ring
      }
    }
 
    m_ToxicClouds.Reserve(partCounter);
 
    ParticleManager gPM = ParticleManager.GetInstance();
 
    array<ParticleSource> createdParticles = gPM.CreateParticlesByIdArr(partId, props, partCounter);
    if (createdParticles.Count() != partCounter)
    {
      if (gPM.IsFinishedAllocating())
      {
        ErrorEx(string.Format("Not enough particles in pool for EffectArea: %1", m_Name));
        OnParticleAllocation(gPM, createdParticles);
      }
      else
        gPM.GetEvents().Event_OnAllocation.Insert(OnParticleAllocation);
    }
    else
      OnParticleAllocation(gPM, createdParticles);
 
    //Debug.Log("Emitter count : " + partCounter );
  }

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(), vector::Up, and vector::Zero.

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

◆ SetupZoneData()

void EffectArea::SetupZoneData ( EffectAreaParams params )

inlineprivate

Definition at line 106 of file EffectArea.c.

  {
    // A lot of branching, allowing to use default values on specified params
    if (params.m_ParamName != "")
      m_Name = params.m_ParamName;
    if (params.m_ParamTriggerType != "")
      m_TriggerType = params.m_ParamTriggerType;
 
    if (params.m_ParamRadius > 0)
      m_Radius = params.m_ParamRadius;
    if (params.m_ParamPosHeight > -1)
      m_PositiveHeight = params.m_ParamPosHeight;
    if (params.m_ParamNegHeight > -1)
      m_NegativeHeight = params.m_ParamNegHeight;
 
    m_InnerRings = params.m_ParamInnerRings;
    if (params.m_ParamInnerSpace > -1)
      m_InnerSpacing = params.m_ParamInnerSpace;
 
    m_OuterRingToggle = params.m_ParamOuterToggle;
    if (params.m_ParamOuterSpace > -1)
      m_OuterSpacing = params.m_ParamOuterSpace;
    m_OuterRingOffset = params.m_ParamOuterOffset;
 
    if (params.m_ParamVertLayers > 0)
      m_VerticalLayers = params.m_ParamVertLayers;
    if (params.m_ParamVerticalOffset > 0)
      m_VerticalOffset = params.m_ParamVerticalOffset;
 
    m_ParticleID = params.m_ParamPartId;
    m_AroundParticleID = params.m_ParamAroundPartId;
    m_TinyParticleID = params.m_ParamTinyPartId;
 
    if (params.m_ParamPpeRequesterType != "")
    {
      m_PPERequesterType = params.m_ParamPpeRequesterType;
      m_PPERequesterIdx = GetRequesterIndex(m_PPERequesterType);
    }
    // We get the PPE index for future usage and synchronization
 
 
    // DEVELOPER NOTE :
    // If you cannot register a new requester, add your own indexation and lookup methods to get an index and synchronize it
    // EXAMPLE : m_PPERequesterIdx = MyLookupMethod()
 
    // We sync our data
    SetSynchDirty();
 
    // Now that everything is ready, we finalize setup
    InitZone();
  }