BoatScript Class Reference

Private Member Functions
void	BoatScript ()
void	~BoatScript ()
override void	EEDelete (EntityAI parent)
void	InitializeActions ()
override void	GetActions (typename action_input_type, out array< ActionBase_Basic > actions)
override bool	DisableVicinityIcon ()
override string	GetVehicleType ()
override bool	IsInventoryVisible ()
override float	GetTransportCameraDistance ()
override vector	GetTransportCameraOffset ()
override int	GetAnimInstance ()
override int	Get3rdPersonCameraType ()
override bool	CrewCanGetThrough (int posIdx)
override bool	CanReachSeatFromSeat (int currentSeat, int nextSeat)
override bool	CanReachSeatFromDoors (string pSeatSelection, vector pFromPos, float pDistance=1.0)
override bool	CanReachDoorsFromSeat (string pDoorsSelection, int pCurrentSeat)
override bool	IsAreaAtDoorFree (int currentSeat, float maxAllowedObjHeight, inout vector extents, out vector transform[4])
override bool	OnBeforeEngineStart ()
override void	OnEngineStart ()
override void	OnEngineStop ()
override void	EEOnCECreate ()
override void	EOnPostSimulate (IEntity other, float timeSlice)
override void	EOnSimulate (IEntity other, float dt)
override void	EOnFrame (IEntity other, float timeSlice)
override void	EOnContact (IEntity other, Contact extra)
override void	EEHitBy (TotalDamageResult damageResult, int damageType, EntityAI source, int component, string dmgZone, string ammo, vector modelPos, float speedCoef)
override void	OnVariablesSynchronized ()
protected override bool	DetectFlipped (VehicleFlippedContext ctx)
override float	OnSound (BoatSoundCtrl ctrl, float oldValue)
override void	HandleByCrewMemberState (ECrewMemberState state)
protected void	DecayHealthTick ()
protected bool	IsInFlagRange ()
bool	CheckOperationalState ()
void	OnVehicleJumpOutServer (GetOutTransportActionData data)
protected void	HandleEngineSound (EBoatEngineSoundState state)
protected void	PlaySound (string soundset, inout EffectSound sound, vector position=vector.Zero)
protected void	HandleBoatSplashSound ()
protected void	SyncSoundImpactLight ()
protected void	SyncSoundImpactHeavy ()
void	SyncSoundPushBoat (bool play)
protected void	FadeEngineSound (bool fadeIn)
protected void	FlipVehicle ()
protected void	CheckContactCache ()
protected void	SetActions ()
void	AddAction (typename actionName)
void	RemoveAction (typename actionName)
protected void	UpdateParticles (float timeSlice=0)
protected void	StopParticleUpdate ()
protected void	ClearWaterEffects ()
protected void	CleanupEffects ()
override void	GetDebugActions (out TSelectableActionInfoArrayEx outputList)
override bool	OnAction (int action_id, Man player, ParamsReadContext ctx)
protected override event	GetOwnerStateType ()
protected override event	GetMoveType ()

Private Attributes
protected const int	DECAY_PLAYER_RANGE = 300
protected const int	DECAY_FLAG_RANGE = 100
protected const float	DECAY_TICK_FREQUENCY = 10
protected const float	DECAY_DAMAGE = 0.017
protected const float	DECAY_FLIPPED_MULT = 4
protected const float	SOUND_ENGINE_FADE = 0.2
protected const float	SPLASH_THRESHOLD_CONDITION = 0.08
protected const float	SPLASH_THRESHOLD = 0.18
private TInputActionMap	m_InputActionMap
private bool	m_ActionsInitialized
protected vector	m_VelocityPrevTick
protected float	m_MomentumPrevTick
protected ref VehicleContactData	m_ContactData
protected ref Timer	m_DecayTimer
protected bool	m_UpdateParticles
protected ref EffectBoatWaterBase	m_WaterEffects [4]
protected bool	m_SplashIncoming
protected bool	m_PlaySoundEngineStopNoFuel
protected bool	m_PlaySoundImpactLight
protected bool	m_PlaySoundImpactHeavy
protected bool	m_PlaySoundPushBoat
protected bool	m_IsEngineSoundFading
protected bool	m_EngineFadeDirection
protected float	m_EngineFadeTime
protected string	m_SoundImpactLight
protected string	m_SoundImpactHeavy
protected string	m_SoundPushBoat
protected string	m_SoundWaterSplash
protected string	m_SoundEngineStart
protected string	m_SoundEngineStop
protected string	m_SoundEngineStartNoFuel
protected string	m_SoundEngineStopNoFuel
protected ref EffectSound	m_SoundPushBoatEffect
protected ref EffectSound	m_SoundWaterSplashEffect
protected ref EffectSound	m_SoundEngineEffect
protected ref EffectSound	m_SoundEngineEffectDeletion

Static Private Attributes
static private ref map< typename, ref TInputActionMap >	m_BoatTypeActionsMap = new map<typename, ref TInputActionMap>()

Constructor & Destructor Documentation

BoatScript()

void BoatScript ( )

inlineprivate

References EffectBoatWaterBase::AttachTo(), CALL_CATEGORY_SYSTEM, DECAY_TICK_FREQUENCY, EffectBoatWaterFront(), EffectBoatWaterSide(), GetGame(), m_DecayTimer, m_PlaySoundImpactHeavy, m_PlaySoundImpactLight, m_SoundEngineStart, m_SoundEngineStartNoFuel, m_SoundEngineStop, m_SoundEngineStopNoFuel, m_SoundImpactHeavy, m_SoundImpactLight, m_SoundPushBoat, m_SoundWaterSplash, and m_WaterEffects.

~BoatScript()

void ~BoatScript ( )

inlineprivate

References CleanupEffects(), m_DecayTimer, and Timer::Stop().

Member Function Documentation

AddAction()

void AddAction ( typename actionName  )

inlineprivate

References Debug::ActionLog(), ActionManagerBase(), ActionBase::GetInputType(), LogManager::IsActionLogEnable(), Debug::LogError(), m_ActionsInitialized, and m_InputActionMap.

Referenced by SetActions().

CanReachDoorsFromSeat()

override bool CanReachDoorsFromSeat ( string  pDoorsSelection, int  pCurrentSeat  )

inlineprivate

CanReachSeatFromDoors()

override bool CanReachSeatFromDoors ( string  pSeatSelection, vector  pFromPos, float  pDistance = 1.0  )

inlineprivate

CanReachSeatFromSeat()

override bool CanReachSeatFromSeat ( int  currentSeat, int  nextSeat  )

inlineprivate

CheckContactCache()

protected void CheckContactCache ( )

inlineprivate

References Math::AbsInt(), GameConstants::CARS_CONTACT_DMG_MIN, GameConstants::CARS_CONTACT_DMG_THRESHOLD, m_ContactData, VehicleContactData::m_Impulse, SyncSoundImpactHeavy(), and SyncSoundImpactLight().

Referenced by EOnPostSimulate().

CheckOperationalState()

bool CheckOperationalState ( )

inlineprivate

References GameConstants::STATE_RUINED.

Referenced by EEHitBy(), and EOnContact().

CleanupEffects()

protected void CleanupEffects ( )

inlineprivate

References SEffectManager::DestroyEffect(), SEffectManager::EffectUnregisterEx(), IsRegistered(), m_SoundPushBoatEffect, m_SoundWaterSplashEffect, m_WaterEffects, and EffectParticle::Stop().

Referenced by EEDelete(), and ~BoatScript().

ClearWaterEffects()

protected void ClearWaterEffects ( )

inlineprivate

References CALL_CATEGORY_SYSTEM, CGame::GetCallQueue(), GetGame(), EffectParticle::GetParticle(), GetParticle(), IsPlaying(), m_WaterEffects, ScriptCallQueue::Remove(), Particle::SetParticleParam(), EffectParticle::Stop(), and StopParticleUpdate().

Referenced by OnEngineStart(), and StopParticleUpdate().

CrewCanGetThrough()

override bool CrewCanGetThrough ( int  posIdx )

inlineprivate

DecayHealthTick()

protected void DecayHealthTick ( )

inlineprivate

References AvoidPlayer(), DECAY_DAMAGE, DECAY_FLIPPED_MULT, DECAY_PLAYER_RANGE, CfgGameplayHandler::GetBoatDecayMultiplier(), GetCEApi(), GetPosition, and IsInFlagRange().

DetectFlipped()

protected override bool DetectFlipped ( VehicleFlippedContext  ctx )

inlineprivate

References GameConstants::VEHICLE_FLIP_ANGLE_TOLERANCE.

DisableVicinityIcon()

override bool DisableVicinityIcon ( )

inlineprivate

EEDelete()

override void EEDelete ( EntityAI  parent )

inlineprivate

References CleanupEffects(), and GetGame().

EEHitBy()

override void EEHitBy ( TotalDamageResult  damageResult, int  damageType, EntityAI  source, int  component, string  dmgZone, string  ammo, vector  modelPos, float  speedCoef  )

inlineprivate

References CheckOperationalState(), component, and IsProxy().

EEOnCECreate()

override void EEOnCECreate ( )

inlineprivate

References Math::RandomFloat().

EOnContact()

override void EOnContact ( IEntity  other, Contact  extra  )

inlineprivate

References CheckOperationalState(), vector::Dot(), GetGame(), GetVelocity(), IsProxy(), m_ContactData, m_MomentumPrevTick, m_VelocityPrevTick, vector::Normalized(), Contact::Position, and VehicleContactData::SetData().

EOnFrame()

override void EOnFrame ( IEntity  other, float  timeSlice  )

inlineprivate

References GetGame(), m_EngineFadeTime, m_IsEngineSoundFading, m_UpdateParticles, and UpdateParticles().

EOnPostSimulate()

override void EOnPostSimulate ( IEntity  other, float  timeSlice  )

inlineprivate

References CheckContactCache(), GetGame(), GetVelocity(), HandleBoatSplashSound(), HandleByCrewMemberState(), IsProxy(), m_MomentumPrevTick, m_PlaySoundEngineStopNoFuel, m_UpdateParticles, and m_VelocityPrevTick.

EOnSimulate()

override void EOnSimulate ( IEntity  other, float  dt  )

inlineprivate

References dBodyGetWorldTransform(), GetGame(), and IsProxy().

FadeEngineSound()

protected void FadeEngineSound ( bool  fadeIn )

inlineprivate

References m_EngineFadeDirection, m_EngineFadeTime, m_IsEngineSoundFading, and SOUND_ENGINE_FADE.

Referenced by OnEngineStart(), and OnEngineStop().

FlipVehicle()

protected void FlipVehicle ( )

inlineprivate

References GetOrientation(), GetPosition, and SetPosition().

Referenced by OnAction().

Get3rdPersonCameraType()

override int Get3rdPersonCameraType ( )

inlineprivate

References DayZPlayerCameras::DAYZCAMERA_3RD_VEHICLE.

GetActions()

override void GetActions ( typename action_input_type  , out array< ActionBase_Basic >  actions  )

inlineprivate

References InitializeActions(), m_ActionsInitialized, and m_InputActionMap.

GetAnimInstance()

override int GetAnimInstance ( )

inlineprivate

GetDebugActions()

override void GetDebugActions ( out TSelectableActionInfoArrayEx  outputList )

inlineprivate

References SAT_DEBUG_ACTION.

GetMoveType()

protected override event GetMoveType ( )

inlineprivate

GetOwnerStateType()

protected override event GetOwnerStateType ( )

inlineprivate

GetTransportCameraDistance()

override float GetTransportCameraDistance ( )

inlineprivate

GetTransportCameraOffset()

override vector GetTransportCameraOffset ( )

inlineprivate

GetVehicleType()

override string GetVehicleType ( )

inlineprivate

HandleBoatSplashSound()

protected void HandleBoatSplashSound ( )

inlineprivate

References SEffectManager::CreateSound(), dBodyGetVelocityAt(), GetGame(), GetPosition, Math::InverseLerp(), m_SoundWaterSplash, m_SoundWaterSplashEffect, m_SplashIncoming, vector::Normalize(), EffectSound::SetAutodestroy(), EffectSound::SetSoundVolume(), SPLASH_THRESHOLD, SPLASH_THRESHOLD_CONDITION, EffectSound::Start(), and CGame::SurfaceGetSeaLevel().

Referenced by EOnPostSimulate().

HandleByCrewMemberState()

override void HandleByCrewMemberState ( ECrewMemberState  state )

inlineprivate

Referenced by EOnPostSimulate().

HandleEngineSound()

protected void HandleEngineSound ( EBoatEngineSoundState  state )

inlineprivate

References GetGame(), EffectSound::GetSoundSet(), m_SoundEngineEffect, m_SoundEngineEffectDeletion, m_SoundEngineStart, m_SoundEngineStartNoFuel, m_SoundEngineStop, m_SoundEngineStopNoFuel, PlaySound(), and EffectSound::SoundStop().

Referenced by OnBeforeEngineStart(), OnEngineStart(), OnEngineStop(), and OnVariablesSynchronized().

InitializeActions()

void InitializeActions ( )

inlineprivate

References m_BoatTypeActionsMap, m_InputActionMap, SetActions(), and Type.

Referenced by GetActions().

IsAreaAtDoorFree()

override bool IsAreaAtDoorFree ( int  currentSeat, float  maxAllowedObjHeight, inout vector  extents, out vector  transform[4]  )

inlineprivate

IsInFlagRange()

protected bool IsInFlagRange ( )

inlineprivate

References DECAY_FLAG_RANGE, vector::Distance(), Mission::GetActiveRefresherLocations(), GetGame(), and CGame::GetMission().

Referenced by DecayHealthTick().

IsInventoryVisible()

override bool IsInventoryVisible ( )

inlineprivate

References GetGame(), and GetPlayer().

OnAction()

override bool OnAction ( int  action_id, Man  player, ParamsReadContext  ctx  )

inlineprivate

References FlipVehicle(), and GetGame().

OnBeforeEngineStart()

override bool OnBeforeEngineStart ( )

inlineprivate

References HandleEngineSound().

OnEngineStart()

override void OnEngineStart ( )

inlineprivate

References ClearWaterEffects(), FadeEngineSound(), GetGame(), and HandleEngineSound().

OnEngineStop()

override void OnEngineStop ( )

inlineprivate

References CALL_CATEGORY_SYSTEM, ScriptCallQueue::CallLater(), dBodyGetWorldTransform(), FadeEngineSound(), CGame::GetCallQueue(), GetGame(), HandleEngineSound(), and StopParticleUpdate().

OnSound()

override float OnSound ( BoatSoundCtrl  ctrl, float  oldValue  )

inlineprivate

References Math::InverseLerp(), m_EngineFadeDirection, m_EngineFadeTime, m_IsEngineSoundFading, and SOUND_ENGINE_FADE.

OnVariablesSynchronized()

override void OnVariablesSynchronized ( )

inlineprivate

References GetPosition, HandleEngineSound(), EffectSound::IsPlaying(), m_PlaySoundEngineStopNoFuel, m_PlaySoundImpactHeavy, m_PlaySoundImpactLight, m_PlaySoundPushBoat, m_SoundImpactHeavy, m_SoundImpactLight, m_SoundPushBoat, m_SoundPushBoatEffect, PlaySound(), and EffectSound::Stop().

OnVehicleJumpOutServer()

void OnVehicleJumpOutServer ( GetOutTransportActionData  data )

inlineprivate

References Math::Clamp(), ActionGetOutTransport::HEALTH_HIGH_SPEED_VALUE, ActionGetOutTransport::HEALTH_LOW_SPEED_VALUE, Math::InverseLerp(), and GetOutTransportActionData::m_Speed.

Referenced by ActionGetOutTransport::ApplyJumpOutDmg().

PlaySound()

protected void PlaySound ( string  soundset, inout EffectSound  sound, vector  position = vector.Zero  )

inlineprivate

References GetPosition, SEffectManager::PlaySoundCachedParams(), EffectSound::SetAutodestroy(), and vector::Zero.

RemoveAction()

void RemoveAction ( typename actionName  )

inlineprivate

References GetGame(), ActionBase::GetInputType(), GetPlayer(), and m_InputActionMap.

SetActions()

protected void SetActions ( )

inlineprivate

References AddAction().

Referenced by InitializeActions().

StopParticleUpdate()

protected void StopParticleUpdate ( )

inlineprivate

References ClearWaterEffects(), and m_UpdateParticles.

Referenced by ClearWaterEffects(), and OnEngineStop().

SyncSoundImpactHeavy()

protected void SyncSoundImpactHeavy ( )

inlineprivate

References m_PlaySoundImpactHeavy.

Referenced by CheckContactCache().

SyncSoundImpactLight()

protected void SyncSoundImpactLight ( )

inlineprivate

References m_PlaySoundImpactLight.

Referenced by CheckContactCache().

SyncSoundPushBoat()

void SyncSoundPushBoat ( bool  play )

inlineprivate

References m_PlaySoundPushBoat.

Referenced by ActionPushBoat::OnEndServer(), and ActionPushBoat::OnStartServer().

UpdateParticles()

protected void UpdateParticles ( float  timeSlice = 0 )

inlineprivate

References m_WaterEffects, and EffectBoatWaterBase::Update().

Referenced by EOnFrame().

Field Documentation

DECAY_DAMAGE

protected const float DECAY_DAMAGE = 0.017

private

Referenced by DecayHealthTick().

DECAY_FLAG_RANGE

protected const int DECAY_FLAG_RANGE = 100

private

Referenced by IsInFlagRange().

DECAY_FLIPPED_MULT

protected const float DECAY_FLIPPED_MULT = 4

private

Referenced by DecayHealthTick().

DECAY_PLAYER_RANGE

protected const int DECAY_PLAYER_RANGE = 300

private

Referenced by DecayHealthTick().

DECAY_TICK_FREQUENCY

protected const float DECAY_TICK_FREQUENCY = 10

private

Referenced by BoatScript().

m_ActionsInitialized

private bool m_ActionsInitialized

private

Referenced by AddAction(), and GetActions().

m_BoatTypeActionsMap

private ref map<typename, ref TInputActionMap> m_BoatTypeActionsMap = new map<typename, ref TInputActionMap>()

staticprivate

Referenced by InitializeActions().

m_ContactData

protected ref VehicleContactData m_ContactData

private

Referenced by CheckContactCache(), and EOnContact().

m_DecayTimer

protected ref Timer m_DecayTimer

private

Referenced by BoatScript(), and ~BoatScript().

m_EngineFadeDirection

protected bool m_EngineFadeDirection

private

Referenced by FadeEngineSound(), and OnSound().

m_EngineFadeTime

protected float m_EngineFadeTime

private

Referenced by EOnFrame(), FadeEngineSound(), and OnSound().

m_InputActionMap

private TInputActionMap m_InputActionMap

private

Referenced by AddAction(), GetActions(), InitializeActions(), and RemoveAction().

m_IsEngineSoundFading

protected bool m_IsEngineSoundFading

private

Referenced by EOnFrame(), FadeEngineSound(), and OnSound().

m_MomentumPrevTick

protected float m_MomentumPrevTick

private

Referenced by EOnContact(), and EOnPostSimulate().

m_PlaySoundEngineStopNoFuel

protected bool m_PlaySoundEngineStopNoFuel

private

Referenced by EOnPostSimulate(), and OnVariablesSynchronized().

m_PlaySoundImpactHeavy

protected bool m_PlaySoundImpactHeavy

private

Referenced by BoatScript(), OnVariablesSynchronized(), and SyncSoundImpactHeavy().

m_PlaySoundImpactLight

protected bool m_PlaySoundImpactLight

private

Referenced by BoatScript(), OnVariablesSynchronized(), and SyncSoundImpactLight().

m_PlaySoundPushBoat

protected bool m_PlaySoundPushBoat

private

Referenced by OnVariablesSynchronized(), and SyncSoundPushBoat().

m_SoundEngineEffect

protected ref EffectSound m_SoundEngineEffect

private

Referenced by HandleEngineSound().

m_SoundEngineEffectDeletion

protected ref EffectSound m_SoundEngineEffectDeletion

private

Referenced by HandleEngineSound().

m_SoundEngineStart

protected string m_SoundEngineStart

private

Referenced by BoatScript(), and HandleEngineSound().

m_SoundEngineStartNoFuel

protected string m_SoundEngineStartNoFuel

private

Referenced by BoatScript(), and HandleEngineSound().

m_SoundEngineStop

protected string m_SoundEngineStop

private

Referenced by BoatScript(), and HandleEngineSound().

m_SoundEngineStopNoFuel

protected string m_SoundEngineStopNoFuel

private

Referenced by BoatScript(), and HandleEngineSound().

m_SoundImpactHeavy

protected string m_SoundImpactHeavy

private

Referenced by BoatScript(), and OnVariablesSynchronized().

m_SoundImpactLight

protected string m_SoundImpactLight

private

Referenced by BoatScript(), and OnVariablesSynchronized().

m_SoundPushBoat

protected string m_SoundPushBoat

private

Referenced by BoatScript(), and OnVariablesSynchronized().

m_SoundPushBoatEffect

protected ref EffectSound m_SoundPushBoatEffect

private

Referenced by CleanupEffects(), and OnVariablesSynchronized().

m_SoundWaterSplash

protected string m_SoundWaterSplash

private

Referenced by BoatScript(), and HandleBoatSplashSound().

m_SoundWaterSplashEffect

protected ref EffectSound m_SoundWaterSplashEffect

private

Referenced by CleanupEffects(), and HandleBoatSplashSound().

m_SplashIncoming

protected bool m_SplashIncoming

private

Referenced by HandleBoatSplashSound().

m_UpdateParticles

protected bool m_UpdateParticles

private

Referenced by EOnFrame(), EOnPostSimulate(), and StopParticleUpdate().

m_VelocityPrevTick

protected vector m_VelocityPrevTick

private

Referenced by EOnContact(), and EOnPostSimulate().

m_WaterEffects

protected ref EffectBoatWaterBase m_WaterEffects[4]

private

Referenced by BoatScript(), CleanupEffects(), ClearWaterEffects(), and UpdateParticles().

SOUND_ENGINE_FADE

protected const float SOUND_ENGINE_FADE = 0.2

private

Referenced by FadeEngineSound(), and OnSound().

SPLASH_THRESHOLD

protected const float SPLASH_THRESHOLD = 0.18

private

Referenced by HandleBoatSplashSound().

SPLASH_THRESHOLD_CONDITION

protected const float SPLASH_THRESHOLD_CONDITION = 0.08

private

Referenced by HandleBoatSplashSound().

---

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

• P:/scripts/4_World/Entities/Vehicles/BoatScript.c