Dayz Build 1.29.163047, Scripts Rev. 123548
Dayz Code Explorer by Zeroy
Loading...
Searching...
No Matches
EffectBoatWaterBase Class Reference
Inheritance diagram for EffectBoatWaterBase:
EffectParticle EffectBoatWaterBack

Protected Member Functions

override void AttachTo (Object obj, vector local_pos="0 0 0", vector local_ori="0 0 0", bool force_rotation_to_world=false)
void EnableEmitor (Particle ptc, int id, bool enable)
void SetParticleState (int state)
void Update (float timeSlice=0)
void UpdatePosToSeaLevel (float timeSlice=0, float surfaceOffset=0)
void UpdateSpeedState (Particle ptc, float speed)

Protected Attributes

BoatScript m_Boat
int m_EmitorCount
vector m_MemPointPos
float m_PosUpdateTimer
int m_SpeedFast
int m_SpeedMedium
int m_SpeedSlow
EBoatSpeed m_SpeedState

Private Attributes

const float POS_UPDATE_THROTTLE = 0.2
Private Attributes inherited from EffectParticle
Particle m_ParticleObj
 The main Particle effect that this Effect wrapper manages.
int m_ParticleID
 The ID in the ParticleList to create Particle from.
vector m_Orientation
 Orientation set by SetOrientation.
bool m_ForceRotationRelativeToWorld
 Orientation setting to be used by the effect when the Effect starts.
vector m_ParticleOrientation
Object m_Object

Additional Inherited Members

Private Member Functions inherited from EffectParticle
override EffectType GetEffectType ()
 Get what type of effect the Effect is.
override bool IsParticle ()
 Check whether the Effect is EffectParticle without casting.
void SetParticle (Particle p)
 Sets the main particle which this Effect will manage.
Particle GetParticle ()
 Gets the main particle which this Effect is managing.
override void Start ()
 Plays all elements this effect consists of.
override void Stop ()
 Stops all elements this effect consists of.
void AttachTo (Object obj, vector local_pos="0 0 0", vector local_ori="0 0 0", bool force_rotation_to_world=false)
 Read Particle.AddAsChild.
void ReAttach ()
 Helper method to attach to parent using stored settings.
void AddAsChild (Object obj, vector local_pos, vector local_ori, bool force_rotation_to_world)
 Helper method to attach to parent.
void Event_OnPlayStart ()
 Event which just simply exists (DEPRECATED).
void Event_OnPlayStarted ()
 Event which just simply exists (DEPRECATED).
void SetParticleID (int id)
 Sets the id of the particle to be used.
int GetParticleID ()
 Gets the id of the particle to be used.
void SetCurrentParticleID (int id)
 Sets the id of the particle to be used.
int GetCurrentParticleID ()
 Gets the current id of the managed Particle.
override void SetCurrentParent (Object parent_obj, bool updateCached=true)
 Set current parent of the managed Particle.
override Object GetCurrentParent ()
 Get the current parent of the managed Particle.
override void SetCurrentPosition (vector pos, bool updateCached=true)
 Set the current world position of the managed Particle.
override vector GetCurrentPosition ()
 Get the current world position of the managed Particle.
override void SetCurrentLocalPosition (vector pos, bool updateCached=true)
 Set the current local position of the managed Particle.
override vector GetCurrentLocalPosition ()
 Get the current local position of the managed Particle.
void SetOrientation (vector ori)
 Set orientation of the EffectParticle.
vector GetOrientation ()
 Get the orientation of the EffectParticle.
void SetCurrentOrientation (vector ori, bool updateCached=true)
 Set the current orientation of the managed Particle.
vector GetCurrentOrientation ()
 Get the current orientation of the managed Particle.
void ForceParticleRotationRelativeToWorld (bool state)
 Set orientation setting to be used by the effect when the Effect starts.
bool IsParticleRotationRelativeToWorld ()
 Get the orientation setting to be used by the effect when the Effect starts.
bool IsParticleCurrentRotationRelativeToWorld ()
 Get the current orientation setting to be used by the managed Particle.
void EffectParticle ()
 ctor
void ~EffectParticle ()
 dtor
override void InitEffect ()
 init
override string GetDebugName ()
 Override when getting debug information.
override void ValidateStart ()
 Validation whether an effect truly started playing or if the Effect should stop as none is present.
void CheckLifeSpan ()
 Was never called and probably should never be called.
void SetDecalOwner (Object o)

Detailed Description

Definition at line 271 of file boatwatereffects.c.

Member Function Documentation

◆ AttachTo()

override void AttachTo ( Object obj,
vector local_pos = "0 0 0",
vector local_ori = "0 0 0",
bool force_rotation_to_world = false )
inlineprotected

Definition at line 285 of file boatwatereffects.c.

References m_Boat, and m_MemPointPos.

◆ EnableEmitor()

void EnableEmitor ( Particle ptc,
int id,
bool enable )
inlineprotected

◆ SetParticleState()

◆ Update()

void Update ( float timeSlice = 0)
inlineprotected

Definition at line 325 of file boatwatereffects.c.

References IsPlaying(), m_SpeedState, and EffectParticle::Start().

◆ UpdatePosToSeaLevel()

void UpdatePosToSeaLevel ( float timeSlice = 0,
float surfaceOffset = 0 )
inlineprotected

◆ UpdateSpeedState()

void UpdateSpeedState ( Particle ptc,
float speed )
inlineprotected

Definition at line 321 of file boatwatereffects.c.

Referenced by Update().

Field Documentation

◆ m_Boat

BoatScript m_Boat
protected

Definition at line 282 of file boatwatereffects.c.

Referenced by AttachTo(), EffectBoatWaterBack::Update(), and UpdatePosToSeaLevel().

◆ m_EmitorCount

◆ m_MemPointPos

vector m_MemPointPos
protected

Definition at line 283 of file boatwatereffects.c.

Referenced by AttachTo(), and UpdatePosToSeaLevel().

◆ m_PosUpdateTimer

float m_PosUpdateTimer
protected

Definition at line 279 of file boatwatereffects.c.

Referenced by UpdatePosToSeaLevel().

◆ m_SpeedFast

◆ m_SpeedMedium

int m_SpeedMedium
protected

◆ m_SpeedSlow

int m_SpeedSlow
protected

◆ m_SpeedState

EBoatSpeed m_SpeedState
protected

Definition at line 281 of file boatwatereffects.c.

Referenced by Update(), and EffectBoatWaterBack::UpdateSpeedState().

◆ POS_UPDATE_THROTTLE

const float POS_UPDATE_THROTTLE = 0.2
private

Definition at line 273 of file boatwatereffects.c.

Referenced by UpdatePosToSeaLevel().


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