class BoatScript

BoatScript › Boat › Transport › Pawn › EntityAI › Entity › ObjectTyped › Object › IEntity › Managed

Full hierarchy 5 Full members 1.118

Base script class for boats

Constructors 1

Constants 8

protected const int DECAY_PLAYER_RANGE = 300

when a player is found within this range, decay is deactivated

Referenced by DecayHealthTick()

protected const int DECAY_FLAG_RANGE = 100

when a boat is parked around a territoryflag, decay is deactivated

Referenced by IsInFlagRange()

protected const float DECAY_TICK_FREQUENCY = 10

seconds

Referenced by BoatScript()

protected const float DECAY_DAMAGE = 0.017

Referenced by DecayHealthTick()

protected const float DECAY_FLIPPED_MULT = 4

Referenced by DecayHealthTick()

protected const float SOUND_ENGINE_FADE = 0.2

Referenced by FadeEngineSound(), and OnSound()

protected const float SPLASH_THRESHOLD_CONDITION = 0.08

diff between sea surface and propeller pos which determines if the splash should happen

Referenced by HandleBoatSplashSound()

protected const float SPLASH_THRESHOLD = 0.18

diff between sea surface and propeller pos which determines when the splash happens

Referenced by HandleBoatSplashSound()

Members 27

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

Referenced by InitializeActions()

private TInputActionMap m_InputActionMap

Referenced by AddAction(), GetActions(), InitializeActions()

Show 1 more

, RemoveAction()

private bool m_ActionsInitialized

Referenced by AddAction(), and GetActions()

protected ref Timer m_DecayTimer

Referenced by BoatScript()

protected bool m_UpdateParticles

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

protected ref EffectBoatWaterBase m_WaterEffects[4]

Referenced by BoatScript(), CleanupEffects(), ClearWaterEffects()

Show 1 more

, UpdateParticles()

protected bool m_SplashIncoming

boat is high enough for the splash to trigger when it falls back down to sea level

Referenced by HandleBoatSplashSound()

protected bool m_PlaySoundEngineStopNoFuel

Referenced by EOnPostSimulate(), and OnVariablesSynchronized()

protected bool m_PlaySoundImpactLight

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

protected bool m_PlaySoundImpactHeavy

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

protected bool m_PlaySoundPushBoat

Referenced by OnVariablesSynchronized(), and SyncSoundPushBoat()

protected bool m_IsEngineSoundFading

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

protected bool m_EngineFadeDirection

true>in | false>out

Referenced by FadeEngineSound(), and OnSound()

protected float m_EngineFadeTime

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

protected string m_SoundImpactLight

Referenced by BoatScript(), and OnVariablesSynchronized()

protected string m_SoundImpactHeavy

Referenced by BoatScript(), and OnVariablesSynchronized()

protected string m_SoundPushBoat

Referenced by BoatScript(), and OnVariablesSynchronized()

protected string m_SoundWaterSplash

Referenced by BoatScript(), and HandleBoatSplashSound()

protected string m_SoundEngineStart

Referenced by BoatScript(), and HandleEngineSound()

protected string m_SoundEngineStop

Referenced by BoatScript(), and HandleEngineSound()

protected string m_SoundEngineStartNoFuel

Referenced by BoatScript(), and HandleEngineSound()

protected string m_SoundEngineStopNoFuel

Referenced by BoatScript(), and HandleEngineSound()

protected ref EffectSound m_SoundPushBoatEffect

Referenced by CleanupEffects(), and OnVariablesSynchronized()

protected ref EffectSound m_SoundWaterSplashEffect

Referenced by CleanupEffects(), and HandleBoatSplashSound()

protected ref EffectSound m_SoundEngineEffect

Referenced by HandleEngineSound()

protected ref EffectSound m_SoundEngineEffectDeletion

hold engine sound which is being stopped & deleted while another is starting

Referenced by HandleEngineSound()

protected float m_HeatComfortOverride

Referenced by BoatScript(), and GetHeatComfortOverride()

Methods 61

void InitializeActions()

References map.Get(), map.Insert(), SetActions()

Show 4 more

, new TInputActionMap(), Class.Type(), m_BoatTypeActionsMap, and m_InputActionMap

Referenced by GetActions()

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

References map.Get(), InitializeActions(), m_ActionsInitialized

Show 1 more

, m_InputActionMap

override bool DisableVicinityIcon()

override string GetVehicleType()

override bool IsInventoryVisible()

References Human.GetCommand_Vehicle(), CGame.GetPlayer(), and HumanCommandVehicle.GetTransport()

override float GetTransportCameraDistance()

override vector GetTransportCameraOffset()

override int GetAnimInstance()

override int Get3rdPersonCameraType()

References DayZPlayerCameras.DAYZCAMERA_3RD_VEHICLE

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 int GetFluidCapacityScript(ETransportFluid fluidType)

References Boat.GetFluidCapacity()

override float GetFluidFractionScript(ETransportFluid fluidType)

References Boat.GetFluidFraction()

override void FillScript(ETransportFluid fluidType, float amount)

References Boat.Fill()

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

References Transport.IsAreaAtDoorFree()

override bool OnBeforeEngineStart()

Gets called everytime the game wants to start the engine.

Returns: true if the engine can start, false otherwise.

References CheckOperationalRequirements()

float GetHeatComfortOverride()

References m_HeatComfortOverride

Referenced by Environment.SetHeatcomfortDirectly()

int CheckOperationalRequirements()

References EntityAI.FindAttachmentBySlotName(), Boat.GetFluidFraction(), Object.GetHealthLevel()

Show 3 more

, Object.IsRuined(), Transport.IsVitalSparkPlug(), and GameConstants.STATE_RUINED

Referenced by OnBeforeEngineStart(), and OnIgnition()

void OnIgnition()

References CheckOperationalRequirements(), and HandleEngineSound()

override void OnEngineStart()

References ClearWaterEffects(), FadeEngineSound(), HandleEngineSound()

Show 2 more

, CGame.IsHeadlessOrDedicatedServer(), and Boat.OnEngineStart()

override void OnEngineStop()

References ScriptCallQueue.CallLater(), dBodyGetWorldTransform(), FadeEngineSound()

Show 8 more

, DayZGame.GetCallQueue(), CGame.GetWaterDepth(), HandleEngineSound(), CGame.IsHeadlessOrDedicatedServer(), Boat.OnEngineStop(), Boat.PropellerGetPosition(), StopParticleUpdate(), and IEntity.VectorToParent()

override void EEOnCECreate()

References Boat.Fill(), Boat.GetFluidCapacity(), and Math.RandomFloat()

override void OnInput(float dt)

References Transport.OnInput()

override void EOnPostSimulate(IEntity other, float timeSlice)

References CheckContactCache(), Boat.EngineIsOn(), Boat.EngineStop()

Show 12 more

, Boat.GetFluidFraction(), Transport.GetMomentum(), GetVelocity(), HandleBoatSplashSound(), CGame.IsHeadlessOrDedicatedServer(), Pawn.IsProxy(), CGame.IsServer(), EntityAI.SetSynchDirty(), Transport.m_MomentumPrevTick, m_PlaySoundEngineStopNoFuel, m_UpdateParticles, and Transport.m_VelocityPrevTick

override void EOnSimulate(IEntity other, float dt)

References dBodyGetWorldTransform(), Boat.EngineIsOn(), Boat.EngineStop()

Show 4 more

, CGame.GetWaterDepth(), Pawn.IsProxy(), Boat.PropellerGetPosition(), and IEntity.VectorToParent()

override void EOnFrame(IEntity other, float timeSlice)

References CGame.IsHeadlessOrDedicatedServer(), UpdateParticles(), m_EngineFadeTime

Show 2 more

, m_IsEngineSoundFading, and m_UpdateParticles

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

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

References CheckOperationalState(), vector.Dot(), Boat.EngineIsOn()

Show 12 more

, Boat.EngineStop(), Transport.GetMomentum(), GetVelocity(), Pawn.IsProxy(), CGame.IsServer(), vector.Normalized(), vector.Normalized(), VehicleContactData.SetData(), new VehicleContactData(), Transport.m_ContactData, Transport.m_MomentumPrevTick, and Transport.m_VelocityPrevTick

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

References CheckOperationalState(), Transport.EEHitBy(), Boat.EngineIsOn()

Show 2 more

, Boat.EngineStop(), and Pawn.IsProxy()

override void OnVariablesSynchronized()

References Object.GetPosition(), HandleEngineSound(), EffectSound.IsPlaying()

Show 11 more

, EntityAI.OnVariablesSynchronized(), PlaySound(), EffectSound.Stop(), m_PlaySoundEngineStopNoFuel, m_PlaySoundImpactHeavy, m_PlaySoundImpactLight, m_PlaySoundPushBoat, m_SoundImpactHeavy, m_SoundImpactLight, m_SoundPushBoat, and m_SoundPushBoatEffect

protected override bool DetectFlipped(VehicleFlippedContext ctx)

References Transport.DetectFlippedUsingSurface(), and GameConstants.VEHICLE_FLIP_ANGLE_TOLERANCE

override float OnSound(BoatSoundCtrl ctrl, float oldValue)

References Math.InverseLerp(), Boat.OnSound(), m_EngineFadeDirection

Show 3 more

, m_EngineFadeTime, m_IsEngineSoundFading, and SOUND_ENGINE_FADE

override void MarkCrewMemberUnconscious(int crewMemberIndex)

References Boat.EngineStop(), and Pawn.IsAuthority()

override void MarkCrewMemberDead(int crewMemberIndex)

References Boat.EngineStop(), and Pawn.IsAuthority()

protected void DecayHealthTick()

References Object.AddHealth(), CEApi.AvoidPlayer(), CfgGameplayHandler.GetBoatDecayMultiplier()

Show 7 more

, GetCEApi(), Object.GetPosition(), Transport.IsFlipped(), IsInFlagRange(), DECAY_DAMAGE, DECAY_FLIPPED_MULT, and DECAY_PLAYER_RANGE

protected bool IsInFlagRange()

References array.Count(), vector.Distance(), array.Get()

Show 4 more

, Mission.GetActiveRefresherLocations(), CGame.GetMission(), Object.GetWorldPosition(), and DECAY_FLAG_RANGE

Referenced by DecayHealthTick()

bool CheckOperationalState()

References EntityAI.FindAttachmentBySlotName(), Object.GetHealthLevel(), Object.IsRuined()

Show 2 more

, Transport.IsVitalSparkPlug(), and GameConstants.STATE_RUINED

Referenced by EEHitBy(), and OnContact()

override void OnDriverExit(Human player)

References Boat.EngineStop(), Boat.GetGear(), Boat.GetNeutralGear()

Show 1 more

, Transport.OnDriverExit()

void OnVehicleJumpOutServer(GetOutTransportActionData data)

References Math.Clamp(), Object.GetPosition(), Math.InverseLerp()

Show 6 more

, Object.ProcessDirectDamage(), Object.WorldToModel(), ActionGetOutTransport.HEALTH_HIGH_SPEED_VALUE, ActionGetOutTransport.HEALTH_LOW_SPEED_VALUE, ActionData.m_Player, and GetOutTransportActionData.m_Speed

Referenced by ActionGetOutTransport.ApplyJumpOutDmg()

protected void HandleEngineSound(EBoatEngineSoundState state)

References EffectSound.GetSoundSet(), CGame.IsHeadlessOrDedicatedServer(), Object.ModelToWorld()

Show 9 more

, PlaySound(), Boat.PropellerGetPosition(), EffectSound.SoundStop(), m_SoundEngineEffect, m_SoundEngineEffectDeletion, m_SoundEngineStart, m_SoundEngineStartNoFuel, m_SoundEngineStop, and m_SoundEngineStopNoFuel

Referenced by OnEngineStart(), OnEngineStop(), OnIgnition()

Show 1 more

, OnVariablesSynchronized()

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

References Object.GetPosition(), EffectSound.IsSoundPlaying(), SEffectManager.PlaySoundCachedParams()

Show 5 more

, Effect.SetAttachmentParent(), EffectSound.SetAutodestroy(), EffectSound.SetCurrentPosition(), EffectSound.SoundPlay(), and vector.Zero

Referenced by HandleEngineSound(), and OnVariablesSynchronized()

protected void HandleBoatSplashSound()

References IEntity.CoordToParent(), SEffectManager.CreateSound(), dBodyGetVelocityAt()

Show 15 more

, Object.GetPosition(), Math.InverseLerp(), vector.Normalize(), Boat.PropellerGetPosition(), Effect.SetAttachmentParent(), EffectSound.SetAutodestroy(), Effect.SetLocalPosition(), EffectSound.SetSoundVolume(), EffectSound.Start(), CGame.SurfaceGetSeaLevel(), m_SoundWaterSplash, m_SoundWaterSplashEffect, m_SplashIncoming, SPLASH_THRESHOLD, and SPLASH_THRESHOLD_CONDITION

Referenced by EOnPostSimulate()

protected void SyncSoundImpactLight()

References EntityAI.SetSynchDirty(), and m_PlaySoundImpactLight

Referenced by CheckContactCache()

protected void SyncSoundImpactHeavy()

References EntityAI.SetSynchDirty(), and m_PlaySoundImpactHeavy

Referenced by CheckContactCache()

void SyncSoundPushBoat(bool play)

References EntityAI.SetSynchDirty(), and m_PlaySoundPushBoat

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

protected void FadeEngineSound(bool fadeIn)

References m_EngineFadeDirection, m_EngineFadeTime, m_IsEngineSoundFading

Show 1 more

, SOUND_ENGINE_FADE

Referenced by OnEngineStart(), and OnEngineStop()

protected void FlipVehicle()

References Object.GetOrientation(), Object.GetPosition(), Object.SetOrientation()

Show 1 more

, Object.SetPosition()

Referenced by OnAction()

protected void CheckContactCache()

References Math.AbsInt(), SyncSoundImpactHeavy(), SyncSoundImpactLight()

Show 4 more

, GameConstants.CARS_CONTACT_DMG_MIN, GameConstants.CARS_CONTACT_DMG_THRESHOLD, Transport.m_ContactData, and VehicleContactData.m_Impulse

Referenced by EOnPostSimulate()

protected void SetActions()

References AddAction()

Referenced by InitializeActions()

void AddAction(typename actionName)

References Debug.ActionLog(), map.Get(), ActionManagerBase.GetAction()

Show 9 more

, ActionBase.GetInputType(), array.Insert(), map.Insert(), LogManager.IsActionLogEnable(), Debug.LogError(), Class.ToString(), Class.ToString(), m_ActionsInitialized, and m_InputActionMap

Referenced by SetActions()

void RemoveAction(typename actionName)

References Class.Cast(), map.Get(), ActionManagerBase.GetAction()

Show 5 more

, PlayerBase.GetActionManager(), ActionBase.GetInputType(), CGame.GetPlayer(), array.RemoveItem(), and m_InputActionMap

protected void UpdateParticles(float timeSlice = 0)

References EffectBoatWaterBase.Update(), and m_WaterEffects

Referenced by EOnFrame()

protected void StopParticleUpdate()

References ClearWaterEffects(), and m_UpdateParticles

Referenced by OnEngineStop()

protected void ClearWaterEffects()

References DayZGame.GetCallQueue(), EffectParticle.GetParticle(), Effect.IsPlaying()

Show 4 more

, ScriptCallQueue.Remove(), Particle.SetParticleParam(), EffectParticle.Stop(), and m_WaterEffects

Referenced by OnEngineStart(), and StopParticleUpdate()

override void CleanupEffects()

References Transport.CleanupEffects(), SEffectManager.DestroyEffect(), SEffectManager.EffectUnregisterEx()

Show 5 more

, Effect.IsRegistered(), EffectParticle.Stop(), m_SoundPushBoatEffect, m_SoundWaterSplashEffect, and m_WaterEffects

override void GetDebugActions(out TSelectableActionInfoArrayEx outputList)

References Transport.GetDebugActions(), array.Insert(), new TSelectableActionInfoWithColor()

Show 1 more

, FadeColors.LIGHT_GREY

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

References FlipVehicle(), CGame.IsServer(), and Transport.OnAction()

protected override event typename GetOwnerStateType()

protected override event typename GetMoveType()

override void FixEntity()DIAG_DEVELOPER

References Boat.Fill(), EntityAI.FixEntity(), Boat.GetFluidCapacity()

Show 1 more

, CGame.IsServer()