Dayz Explorer 1.28.160049
Loading...
Searching...
No Matches
Protected Member Functions | Protected Attributes | List of all members
BoatScript Class Reference
Inheritance diagram for BoatScript:
Boat_01_ColorBase

Protected 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 ()
 
int CheckOperationalRequirements ()
 
void OnIgnition ()
 
override void OnEngineStart ()
 
override void OnEngineStop ()
 
override void EEOnCECreate ()
 
override void OnInput (float dt)
 
override void EOnPostSimulate (IEntity other, float timeSlice)
 
override void EOnSimulate (IEntity other, float dt)
 
override void EOnFrame (IEntity other, float timeSlice)
 
override void OnContact (string zoneName, vector localPos, IEntity other, Contact data)
 WARNING: Can be called very frequently in one frame, use with caution.
 
override void EEHitBy (TotalDamageResult damageResult, int damageType, EntityAI source, int component, string dmgZone, string ammo, vector modelPos, float speedCoef)
 
override void OnVariablesSynchronized ()
 
override bool DetectFlipped (VehicleFlippedContext ctx)
 
override float OnSound (BoatSoundCtrl ctrl, float oldValue)
 
override void MarkCrewMemberUnconscious (int crewMemberIndex)
 
override void MarkCrewMemberDead (int crewMemberIndex)
 
void DecayHealthTick ()
 
bool IsInFlagRange ()
 
bool CheckOperationalState ()
 
override void OnDriverExit (Human player)
 
void OnVehicleJumpOutServer (GetOutTransportActionData data)
 
void HandleEngineSound (EBoatEngineSoundState state)
 
void PlaySound (string soundset, inout EffectSound sound, vector position=vector.Zero)
 
void HandleBoatSplashSound ()
 
void SyncSoundImpactLight ()
 
void SyncSoundImpactHeavy ()
 
void SyncSoundPushBoat (bool play)
 
void FadeEngineSound (bool fadeIn)
 
void FlipVehicle ()
 
void CheckContactCache ()
 
void SetActions ()
 
void AddAction (typename actionName)
 
void RemoveAction (typename actionName)
 
void UpdateParticles (float timeSlice=0)
 
void StopParticleUpdate ()
 
void ClearWaterEffects ()
 
void CleanupEffects ()
 
override void GetDebugActions (out TSelectableActionInfoArrayEx outputList)
 
override bool OnAction (int action_id, Man player, ParamsReadContext ctx)
 
override event GetOwnerStateType ()
 
override event GetMoveType ()
 

Protected Attributes

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

Detailed Description

Base script class for boats

Definition at line 41 of file boatscript.c.

Constructor & Destructor Documentation

◆ BoatScript()

void BoatScript::BoatScript ( )
protected

Definition at line 90 of file boatscript.c.

◆ ~BoatScript()

void BoatScript::~BoatScript ( )
protected

Definition at line 143 of file boatscript.c.

Member Function Documentation

◆ AddAction()

void BoatScript::AddAction ( typename actionName )
protected

Definition at line 754 of file boatscript.c.

◆ CanReachDoorsFromSeat()

override bool BoatScript::CanReachDoorsFromSeat ( string pDoorsSelection,
int pCurrentSeat )
protected

Definition at line 232 of file boatscript.c.

◆ CanReachSeatFromDoors()

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

Definition at line 227 of file boatscript.c.

◆ CanReachSeatFromSeat()

override bool BoatScript::CanReachSeatFromSeat ( int currentSeat,
int nextSeat )
protected

Definition at line 222 of file boatscript.c.

◆ CheckContactCache()

void BoatScript::CheckContactCache ( )
protected

Definition at line 732 of file boatscript.c.

◆ CheckOperationalRequirements()

int BoatScript::CheckOperationalRequirements ( )
protected

Definition at line 254 of file boatscript.c.

◆ CheckOperationalState()

bool BoatScript::CheckOperationalState ( )
protected

Definition at line 564 of file boatscript.c.

◆ CleanupEffects()

void BoatScript::CleanupEffects ( )
protected

Definition at line 833 of file boatscript.c.

◆ ClearWaterEffects()

void BoatScript::ClearWaterEffects ( )
protected

Definition at line 814 of file boatscript.c.

◆ CrewCanGetThrough()

override bool BoatScript::CrewCanGetThrough ( int posIdx)
protected

Definition at line 217 of file boatscript.c.

◆ DecayHealthTick()

void BoatScript::DecayHealthTick ( )
protected

Definition at line 526 of file boatscript.c.

◆ DetectFlipped()

override bool BoatScript::DetectFlipped ( VehicleFlippedContext ctx)
protected

Definition at line 482 of file boatscript.c.

◆ DisableVicinityIcon()

override bool BoatScript::DisableVicinityIcon ( )
protected

Definition at line 182 of file boatscript.c.

◆ EEDelete()

override void BoatScript::EEDelete ( EntityAI parent)
protected

Definition at line 153 of file boatscript.c.

◆ EEHitBy()

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

Definition at line 441 of file boatscript.c.

◆ EEOnCECreate()

override void BoatScript::EEOnCECreate ( )
protected

Definition at line 334 of file boatscript.c.

◆ EOnFrame()

override void BoatScript::EOnFrame ( IEntity other,
float timeSlice )
protected

Definition at line 401 of file boatscript.c.

◆ EOnPostSimulate()

override void BoatScript::EOnPostSimulate ( IEntity other,
float timeSlice )
protected

Definition at line 347 of file boatscript.c.

◆ EOnSimulate()

override void BoatScript::EOnSimulate ( IEntity other,
float dt )
protected

Definition at line 385 of file boatscript.c.

◆ FadeEngineSound()

void BoatScript::FadeEngineSound ( bool fadeIn)
protected

Definition at line 714 of file boatscript.c.

◆ FlipVehicle()

void BoatScript::FlipVehicle ( )
protected

Definition at line 721 of file boatscript.c.

◆ Get3rdPersonCameraType()

override int BoatScript::Get3rdPersonCameraType ( )
protected

Definition at line 212 of file boatscript.c.

◆ GetActions()

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

Definition at line 171 of file boatscript.c.

◆ GetAnimInstance()

override int BoatScript::GetAnimInstance ( )
protected

Definition at line 207 of file boatscript.c.

◆ GetDebugActions()

override void BoatScript::GetDebugActions ( out TSelectableActionInfoArrayEx outputList)
protected

Definition at line 848 of file boatscript.c.

◆ GetMoveType()

override event BoatScript::GetMoveType ( )
protected

Definition at line 880 of file boatscript.c.

◆ GetOwnerStateType()

override event BoatScript::GetOwnerStateType ( )
protected

Definition at line 875 of file boatscript.c.

◆ GetTransportCameraDistance()

override float BoatScript::GetTransportCameraDistance ( )
protected

Definition at line 197 of file boatscript.c.

◆ GetTransportCameraOffset()

override vector BoatScript::GetTransportCameraOffset ( )
protected

Definition at line 202 of file boatscript.c.

◆ GetVehicleType()

override string BoatScript::GetVehicleType ( )
protected

Definition at line 187 of file boatscript.c.

◆ HandleBoatSplashSound()

void BoatScript::HandleBoatSplashSound ( )
protected

Definition at line 662 of file boatscript.c.

◆ HandleEngineSound()

void BoatScript::HandleEngineSound ( EBoatEngineSoundState state)
protected

Definition at line 598 of file boatscript.c.

◆ InitializeActions()

void BoatScript::InitializeActions ( )
protected

Definition at line 159 of file boatscript.c.

◆ IsAreaAtDoorFree()

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

Definition at line 237 of file boatscript.c.

◆ IsInFlagRange()

bool BoatScript::IsInFlagRange ( )
protected

Definition at line 542 of file boatscript.c.

◆ IsInventoryVisible()

override bool BoatScript::IsInventoryVisible ( )
protected

Definition at line 192 of file boatscript.c.

◆ MarkCrewMemberDead()

override void BoatScript::MarkCrewMemberDead ( int crewMemberIndex)
protected

Definition at line 515 of file boatscript.c.

◆ MarkCrewMemberUnconscious()

override void BoatScript::MarkCrewMemberUnconscious ( int crewMemberIndex)
protected

Definition at line 504 of file boatscript.c.

◆ OnAction()

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

Definition at line 855 of file boatscript.c.

◆ OnBeforeEngineStart()

override bool BoatScript::OnBeforeEngineStart ( )
protected

Gets called everytime the game wants to start the engine.

Returns
true if the engine can start, false otherwise.

Definition at line 247 of file boatscript.c.

◆ OnContact()

override void BoatScript::OnContact ( string zoneName,
vector localPos,
IEntity other,
Contact data )
protected

WARNING: Can be called very frequently in one frame, use with caution.

Definition at line 418 of file boatscript.c.

◆ OnDriverExit()

override void BoatScript::OnDriverExit ( Human player)
protected

Definition at line 579 of file boatscript.c.

◆ OnEngineStart()

override void BoatScript::OnEngineStart ( )
protected

Definition at line 302 of file boatscript.c.

◆ OnEngineStop()

override void BoatScript::OnEngineStop ( )
protected

Definition at line 314 of file boatscript.c.

◆ OnIgnition()

void BoatScript::OnIgnition ( )
protected

Definition at line 280 of file boatscript.c.

◆ OnInput()

override void BoatScript::OnInput ( float dt)
protected

Definition at line 342 of file boatscript.c.

◆ OnSound()

override float BoatScript::OnSound ( BoatSoundCtrl ctrl,
float oldValue )
protected

Definition at line 489 of file boatscript.c.

◆ OnVariablesSynchronized()

override void BoatScript::OnVariablesSynchronized ( )
protected

Definition at line 452 of file boatscript.c.

◆ OnVehicleJumpOutServer()

void BoatScript::OnVehicleJumpOutServer ( GetOutTransportActionData data)
protected

Definition at line 590 of file boatscript.c.

◆ PlaySound()

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

Definition at line 639 of file boatscript.c.

◆ RemoveAction()

void BoatScript::RemoveAction ( typename actionName )
protected

Definition at line 787 of file boatscript.c.

◆ SetActions()

void BoatScript::SetActions ( )
protected

Definition at line 748 of file boatscript.c.

◆ StopParticleUpdate()

void BoatScript::StopParticleUpdate ( )
protected

Definition at line 808 of file boatscript.c.

◆ SyncSoundImpactHeavy()

void BoatScript::SyncSoundImpactHeavy ( )
protected

Definition at line 695 of file boatscript.c.

◆ SyncSoundImpactLight()

void BoatScript::SyncSoundImpactLight ( )
protected

Definition at line 686 of file boatscript.c.

◆ SyncSoundPushBoat()

void BoatScript::SyncSoundPushBoat ( bool play)
protected

Definition at line 704 of file boatscript.c.

◆ UpdateParticles()

void BoatScript::UpdateParticles ( float timeSlice = 0)
protected

Definition at line 800 of file boatscript.c.

Member Data Documentation

◆ DECAY_DAMAGE

const float BoatScript::DECAY_DAMAGE = 0.017
protected

Definition at line 46 of file boatscript.c.

◆ DECAY_FLAG_RANGE

const int BoatScript::DECAY_FLAG_RANGE = 100
protected

Definition at line 44 of file boatscript.c.

◆ DECAY_FLIPPED_MULT

const float BoatScript::DECAY_FLIPPED_MULT = 4
protected

Definition at line 47 of file boatscript.c.

◆ DECAY_PLAYER_RANGE

const int BoatScript::DECAY_PLAYER_RANGE = 300
protected

Definition at line 43 of file boatscript.c.

◆ DECAY_TICK_FREQUENCY

const float BoatScript::DECAY_TICK_FREQUENCY = 10
protected

Definition at line 45 of file boatscript.c.

◆ m_ContactData

ref VehicleContactData BoatScript::m_ContactData
protected

Definition at line 59 of file boatscript.c.

◆ m_DecayTimer

ref Timer BoatScript::m_DecayTimer
protected

Definition at line 60 of file boatscript.c.

◆ m_EngineFadeDirection

bool BoatScript::m_EngineFadeDirection
protected

Definition at line 73 of file boatscript.c.

◆ m_EngineFadeTime

float BoatScript::m_EngineFadeTime
protected

Definition at line 74 of file boatscript.c.

◆ m_IsEngineSoundFading

bool BoatScript::m_IsEngineSoundFading
protected

Definition at line 72 of file boatscript.c.

◆ m_MomentumPrevTick

float BoatScript::m_MomentumPrevTick
protected

Definition at line 58 of file boatscript.c.

◆ m_PlaySoundEngineStopNoFuel

bool BoatScript::m_PlaySoundEngineStopNoFuel
protected

Definition at line 68 of file boatscript.c.

◆ m_PlaySoundImpactHeavy

bool BoatScript::m_PlaySoundImpactHeavy
protected

Definition at line 70 of file boatscript.c.

◆ m_PlaySoundImpactLight

bool BoatScript::m_PlaySoundImpactLight
protected

Definition at line 69 of file boatscript.c.

◆ m_PlaySoundPushBoat

bool BoatScript::m_PlaySoundPushBoat
protected

Definition at line 71 of file boatscript.c.

◆ m_SoundEngineEffect

ref EffectSound BoatScript::m_SoundEngineEffect
protected

Definition at line 87 of file boatscript.c.

◆ m_SoundEngineEffectDeletion

ref EffectSound BoatScript::m_SoundEngineEffectDeletion
protected

Definition at line 88 of file boatscript.c.

◆ m_SoundEngineStart

string BoatScript::m_SoundEngineStart
protected

Definition at line 79 of file boatscript.c.

◆ m_SoundEngineStartNoFuel

string BoatScript::m_SoundEngineStartNoFuel
protected

Definition at line 81 of file boatscript.c.

◆ m_SoundEngineStop

string BoatScript::m_SoundEngineStop
protected

Definition at line 80 of file boatscript.c.

◆ m_SoundEngineStopNoFuel

string BoatScript::m_SoundEngineStopNoFuel
protected

Definition at line 82 of file boatscript.c.

◆ m_SoundImpactHeavy

string BoatScript::m_SoundImpactHeavy
protected

Definition at line 76 of file boatscript.c.

◆ m_SoundImpactLight

string BoatScript::m_SoundImpactLight
protected

Definition at line 75 of file boatscript.c.

◆ m_SoundPushBoat

string BoatScript::m_SoundPushBoat
protected

Definition at line 77 of file boatscript.c.

◆ m_SoundPushBoatEffect

ref EffectSound BoatScript::m_SoundPushBoatEffect
protected

Definition at line 85 of file boatscript.c.

◆ m_SoundWaterSplash

string BoatScript::m_SoundWaterSplash
protected

Definition at line 78 of file boatscript.c.

◆ m_SoundWaterSplashEffect

ref EffectSound BoatScript::m_SoundWaterSplashEffect
protected

Definition at line 86 of file boatscript.c.

◆ m_SplashIncoming

bool BoatScript::m_SplashIncoming
protected

Definition at line 67 of file boatscript.c.

◆ m_UpdateParticles

bool BoatScript::m_UpdateParticles
protected

Definition at line 63 of file boatscript.c.

◆ m_VelocityPrevTick

vector BoatScript::m_VelocityPrevTick
protected

Definition at line 57 of file boatscript.c.

◆ m_WaterEffects

ref EffectBoatWaterBase BoatScript::m_WaterEffects[4]
protected

Definition at line 64 of file boatscript.c.

◆ SOUND_ENGINE_FADE

const float BoatScript::SOUND_ENGINE_FADE = 0.2
protected

Definition at line 49 of file boatscript.c.

◆ SPLASH_THRESHOLD

const float BoatScript::SPLASH_THRESHOLD = 0.18
protected

Definition at line 51 of file boatscript.c.

◆ SPLASH_THRESHOLD_CONDITION

const float BoatScript::SPLASH_THRESHOLD_CONDITION = 0.08
protected

Definition at line 50 of file boatscript.c.

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