class CCTLiquid

CCTLiquid › CCTBase

Constructors 1

void CCTLiquid(int allowedLiquidSource, float maximalTargetDistance = UAMaxDistances.DEFAULT, float maxVerticalReach = UAMaxDistances.DEFAULT, SurfaceDetectionType surfaceDetectionType = SurfaceDetectionType.Roadway, bool allowSeaLevelCursorFallback = false)

References DiagMenu.GetBool(), new SurfaceDetectionParameters(), SurfaceDetectionParameters.includeWater

Show 15 more

, m_AllowedLiquidSource, m_AllowSeaLevelCursorFallback, m_DebugSyntheticCursor, m_DebugSyntheticCursorShapes, m_HasLastSyntheticHitCursor, m_LastSyntheticHitCursor, m_LastSyntheticHitCursorTime, m_MaxActionDistance, m_MaxVerticalReach, m_SurfaceDetectionParams, m_SurfaceDetectionParamsNoWater, SurfaceDetectionParameters.rsd, SurfaceDetectionParameters.syncMode, SurfaceDetectionParameters.type, and vector.Zero

Referenced by ActionDrinkPondContinuous.CreateConditionComponents(), ActionDrinkThroughContinuous.CreateConditionComponents(), ActionEatSnowContinuous.CreateConditionComponents()

Show 10 more

Constants 14

protected static const float HIT_POS_TOLERANCE = 1.0

protected static const float HIT_POS_TOLERANCE_SQ = HIT_POS_TOLERANCE * HIT_POS_TOLERANCE

protected static const float SEA_FALLBACK_DISTANCE_BUFFER = 1.5

Referenced by TryBuildSeaLevelHitPosition()

protected static const float SYNTHETIC_POND_SAMPLE_STEP = 1.0

Referenced by TryBuildPondHitPosition()

protected static const float SYNTHETIC_POND_SURFACE_TOLERANCE = 0.35

Referenced by TryBuildPondHitPosition(), and TryValidatePondHitPosition()

protected static const float SYNTHETIC_POND_FALLBACK_SURFACE_TOLERANCE = 1.75

Referenced by TryBuildPondHitPosition()

protected static const float SYNTHETIC_CURSOR_DISTANCE_BUFFER = 1.5

Referenced by IsPositionNearCurrentCameraRay(), and TryBuildPondHitPosition()

protected static const float SEA_CURSOR_STICK_DISTANCE = 0.75

Referenced by ApplySyntheticHitCursorStability()

protected static const int SEA_CURSOR_STICK_TIME_MS = 350

Referenced by ApplySyntheticHitCursorStability()

protected static const float SYNTHETIC_CURSOR_CACHE_AIM_TOLERANCE = 1.75

Referenced by IsCachedSyntheticCursorRelevant()

protected static const int SYNTHETIC_CURSOR_CACHE_MAX_AGE_MS = 350

Referenced by TryUseCachedSyntheticCursor()

protected static const float SEA_HIT_RAW_Y_TOLERANCE = 1.25

Referenced by TryGetNormalizedSeaHitPoint()

protected static const float SEA_CURSOR_MIN_DOWN_DOT = 0.035

Referenced by TryBuildSeaLevelHitPosition()

protected static const float LIQUID_SURFACE_RAYCAST_OFFSET = 0.2

Referenced by CheckSurfaceLiquid(), TryBuildPondHitPosition(), and TryBuildSeaLevelHitPosition()

Members 14

protected vector m_LastSyntheticHitCursor

Referenced by ApplySyntheticHitCursorStability(), CCTLiquid(), ClearSyntheticCursorCache()

Show 1 more

, TryUseCachedSyntheticCursor()

protected bool m_HasLastSyntheticHitCursor

Referenced by ApplySyntheticHitCursorStability(), CCTLiquid(), ClearSyntheticCursorCache()

Show 1 more

, TryUseCachedSyntheticCursor()

protected int m_LastSyntheticHitCursorTime

Referenced by ApplySyntheticHitCursorStability(), CCTLiquid(), ClearSyntheticCursorCache()

Show 1 more

, TryUseCachedSyntheticCursor()

protected float m_MaxVerticalReach

Referenced by CCTLiquid(), CheckSurfaceLiquid(), IsAllowedPondLiquidSurface()

Show 3 more

, IsValidTargetObject(), TryBuildSeaLevelHitPosition(), and TryGetNormalizedSeaHitPoint()

protected float m_MaxActionDistance

Referenced by CCTLiquid(), CheckSurfaceLiquid(), IsAllowedPondLiquidSurface()

Show 6 more

, IsPositionNearCurrentCameraRay(), IsValidTargetObject(), TryBuildPondHitPosition(), TryBuildSeaLevelHitPosition(), TryGetNormalizedSeaHitPoint(), and TryValidatePondHitPosition()

protected int m_AllowedLiquidSource

Referenced by CCTLiquid(), IsAllowedPondLiquidSurface(), IsValidLiquid()

Show 2 more

, TryBuildSyntheticCursor(), and TryValidateHitCursor()

protected ref SurfaceDetectionParameters m_SurfaceDetectionParams

Referenced by CCTLiquid(), CheckSurfaceLiquid(), and TryGetLiquidSurfaceAt()

protected ref SurfaceDetectionParameters m_SurfaceDetectionParamsNoWater

Referenced by CCTLiquid(), and TryGetNonWaterSurfaceAt()

protected int m_LiquidType = LIQUID_NONE

Referenced by Can(), CheckSeaLevelFallback(), CheckSurfaceLiquid()

Show 1 more

, GetLiquidType()

protected int m_WaterSourceType = EWaterSourceObjectType.NONE

Referenced by Can(), and GetWaterSourceType()

protected int m_LiquidSourceType = ELiquidSourceObjectType.NONE

Referenced by Can(), and GetLiquidSourceType()

protected bool m_AllowSeaLevelCursorFallback

Referenced by Can(), and CCTLiquid()

protected bool m_DebugSyntheticCursorDIAG_DEVELOPER

Referenced by Can(), CCTLiquid(), TryBuildPondHitPosition()

Show 2 more

, TryBuildSeaLevelHitPosition(), and TryResolveSyntheticCursor()

protected ref array<Shape> m_DebugSyntheticCursorShapesDIAG_DEVELOPER

Referenced by CCTLiquid(), ClearDebugCursorShapes(), and DebugDrawSyntheticCursor()

Methods 31

override bool Can(PlayerBase player, ActionTarget target)

References DbgUI.Begin(), CheckSeaLevelFallback(), CheckSurfaceLiquid()

Show 31 more

, array.Count(), DbgUI.End(), array.Find(), string.Format(), Object.GetActionComponentsForSelectionName(), DiagMenu.GetBool(), ActionTarget.GetComponentIndex(), ActionTarget.GetCursorHitPos(), Object.GetLiquidSourceObjectType(), Object.GetLiquidSourceType(), ActionTarget.GetObject(), Object.GetPosition(), Object.GetPosition(), Object.GetViewGeometryLevel(), Object.GetWaterSourceObjectType(), ActionTarget.IsProxy(), IsValidLiquid(), IsValidTargetObject(), Object.IsWell(), ActionTarget.SetCursorHitPos(), DbgUI.Text(), new TIntArray(), TryResolveSyntheticCursor(), string.Empty, UAMisc.LIQUID_SOURCE_SELECTION, m_AllowSeaLevelCursorFallback, m_DebugSyntheticCursor, m_LiquidSourceType, m_LiquidType, m_WaterSourceType, and vector.Zero

Referenced by ActionFillBottleBase.ActionCondition(), and CanContinue()

protected bool IsValidLiquid(int liquid)

Fishing/synthetic/sea-normalized cursor path For fishing or other synthetic cursor actions, do not fall through to generic surface checks. If the synthetic cursor cannot be resolved, the action should not be available.

References m_AllowedLiquidSource

Referenced by Can()

protected bool IsValidTargetObject(vector playerPos, vector objectPosition, EWaterSourceObjectType waterSourceType, ELiquidSourceObjectType liquidSourceType, bool isProxy)

References Math.AbsFloat(), vector.Distance(), IsNearlyZero()

Show 2 more

, m_MaxActionDistance, and m_MaxVerticalReach

Referenced by Can()

protected bool CheckSurfaceLiquid(PlayerBase player, Object targetObj, vector hitPosition, vector playerPos, bool isValidInteract, out string surfaceType)

Check vertical distance

References Math.AbsFloat(), CGame.CorrectLiquidType(), vector.Distance()

Show 16 more

, SurfaceInfo.GetLiquidType(), CGame.GetSurface(), SurfaceInfo.GetSurfaceType(), HasClearPathToLiquidSurface(), IsCursorActuallyOnLiquidSurface(), IsNearlyZero(), new SurfaceDetectionResult(), string.Empty, SurfaceDetectionResult.height, LIQUID_SURFACE_RAYCAST_OFFSET, m_LiquidType, m_MaxActionDistance, m_MaxVerticalReach, m_SurfaceDetectionParams, SurfaceDetectionParameters.position, and SurfaceDetectionResult.surface

Referenced by Can()

protected bool HasClearPathToLiquidSurface(PlayerBase player, vector surfacePos)

Do not allow water merely below grass/terrain.

References vector.Distance(), MiscGameplayFunctions.GetHeadBonePos(), new RaycastRVParams()

Show 7 more

, DayZPhysics.RaycastRVProxy(), RaycastRVParams.flags, RaycastRVParams.ignore, RaycastRVResult.obj, RaycastRVResult.pos, RaycastRVParams.sorted, and RaycastRVParams.type

Referenced by CheckSurfaceLiquid(), TryBuildPondHitPosition(), TryBuildSeaLevelHitPosition()

Show 1 more

, TryValidateHitCursor()

protected bool CheckSeaLevelFallback(vector hitPosition, vector playerPos)

Something solid is between player and the liquid point.

References TryGetNormalizedSeaHitPoint(), and m_LiquidType

Referenced by Can()

protected bool TryGetLiquidSurfaceAt(vector probePosition, out vector surfacePosition, out int liquidType, out string surfaceType)

References CGame.CorrectLiquidType(), SurfaceInfo.GetLiquidType(), CGame.GetSurface()

Show 8 more

, SurfaceInfo.GetSurfaceType(), new SurfaceDetectionResult(), string.Empty, SurfaceDetectionResult.height, m_SurfaceDetectionParams, SurfaceDetectionParameters.position, SurfaceDetectionResult.surface, and vector.Zero

Referenced by TryBuildPondHitPosition(), and TryValidatePondHitPosition()

protected bool TryBuildSeaLevelHitPosition(PlayerBase player, vector playerPos, out vector seaHitPosition)

References ApplySyntheticHitCursorStability(), DbgUI.Begin(), vector.Distance()

Show 21 more

, vector.DistanceSq(), DbgUI.End(), string.Format(), CGame.GetCurrentCameraDirection(), CGame.GetCurrentCameraPosition(), HasClearPathToLiquidSurface(), CGame.IsHeadlessOrDedicatedServer(), IsSeaHitPositionValid(), vector.Normalize(), CGame.SurfaceGetSeaLevel(), CGame.SurfaceGetSeaLevelMax(), DbgUI.Text(), vector.ToString(), vector.ToString(), LIQUID_SURFACE_RAYCAST_OFFSET, m_DebugSyntheticCursor, m_MaxActionDistance, m_MaxVerticalReach, SEA_CURSOR_MIN_DOWN_DOT, SEA_FALLBACK_DISTANCE_BUFFER, and vector.Zero

Referenced by TryBuildSyntheticCursor()

protected bool IsSeaHitPositionValid(vector playerPos, vector hitPosition)

Apply small deadband/sticky cache.

References TryGetNormalizedSeaHitPoint()

Referenced by ApplySyntheticHitCursorStability(), and TryBuildSeaLevelHitPosition()

protected bool TryBuildPondHitPosition(PlayerBase player, vector playerPos, out vector pondHitPosition)

References Math.AbsFloat(), ApplySyntheticHitCursorStability(), DbgUI.Begin()

Show 20 more

, DbgUI.End(), string.Format(), CGame.GetCurrentCameraDirection(), CGame.GetCurrentCameraPosition(), HasClearPathToLiquidSurface(), IsAllowedPondLiquidSurface(), CGame.IsHeadlessOrDedicatedServer(), IsNearlyZero(), IsValidPondHitPosition(), vector.Normalize(), DbgUI.Text(), TryGetLiquidSurfaceAt(), LIQUID_SURFACE_RAYCAST_OFFSET, m_DebugSyntheticCursor, m_MaxActionDistance, SYNTHETIC_CURSOR_DISTANCE_BUFFER, SYNTHETIC_POND_FALLBACK_SURFACE_TOLERANCE, SYNTHETIC_POND_SAMPLE_STEP, SYNTHETIC_POND_SURFACE_TOLERANCE, and vector.Zero

Referenced by TryBuildSyntheticCursor()

protected bool IsValidPondHitPosition(vector playerPos, vector hitPosition, int liquidType = LIQUID_NONE)

Last chance: use closest sampled surface if it was very close.

References TryValidatePondHitPosition()

Referenced by ApplySyntheticHitCursorStability(), and TryBuildPondHitPosition()

protected bool TryGetNormalizedSeaHitPoint(vector playerPos, vector hitPosition, out vector normalizedHit)

References Math.AbsFloat(), vector.Distance(), IsNearlyZero()

Show 7 more

, CGame.SurfaceGetSeaLevel(), CGame.SurfaceGetSeaLevelMax(), CGame.SurfaceIsSea(), m_MaxActionDistance, m_MaxVerticalReach, SEA_HIT_RAW_Y_TOLERANCE, and vector.Zero

Referenced by CheckSeaLevelFallback(), IsSeaHitPositionValid(), and TryValidateHitCursor()

protected bool TryBuildSyntheticCursor(PlayerBase player, vector playerPos, out vector syntheticHitPosition, out int syntheticLiquidType)

Preserve ValidateDistances() vertical behavior for normalized sea hits.

References CGame.IsHeadlessOrDedicatedServer(), TryBuildPondHitPosition(), TryBuildSeaLevelHitPosition()

Show 2 more

, m_AllowedLiquidSource, and vector.Zero

Referenced by TryResolveSyntheticCursor()

protected bool TryResolveSyntheticCursor(PlayerBase player, vector playerPos, vector currentHitPosition, out vector resolvedHitPosition, out int resolvedLiquidType)

Let final validation detect exact liquid type.

References ClearDebugCursorShapes(), ClearSyntheticCursorCache(), DebugDrawSyntheticCursor()

Show 6 more

, CGame.IsHeadlessOrDedicatedServer(), TryBuildSyntheticCursor(), TryUseCachedSyntheticCursor(), TryValidateHitCursor(), m_DebugSyntheticCursor, and vector.Zero

Referenced by Can()

protected bool TryValidatePondHitPosition(vector playerPos, vector hitPosition, out vector surfacePos, out int liquidType, out string surfaceType, int expectedLiquidType = LIQUID_NONE)

Validate the generated cursor once.

References Math.AbsFloat(), vector.Distance(), IsAllowedPondLiquidSurface()

Show 7 more

, IsNearlyZero(), CGame.SurfaceIsPond(), TryGetLiquidSurfaceAt(), string.Empty, m_MaxActionDistance, SYNTHETIC_POND_SURFACE_TOLERANCE, and vector.Zero

Referenced by IsValidPondHitPosition(), and TryValidateHitCursor()

protected void ClearSyntheticCursorCache()

If caller expected a specific liquid mask/type, require compatibility.

References m_HasLastSyntheticHitCursor, m_LastSyntheticHitCursor, m_LastSyntheticHitCursorTime

Show 1 more

, vector.Zero

Referenced by TryResolveSyntheticCursor()

protected vector ApplySyntheticHitCursorStability(vector playerPos, vector candidate, int liquidType)

References vector.DistanceSq(), CGame.GetTime(), IsSeaHitPositionValid()

Show 6 more

, IsValidPondHitPosition(), m_HasLastSyntheticHitCursor, m_LastSyntheticHitCursor, m_LastSyntheticHitCursorTime, SEA_CURSOR_STICK_DISTANCE, and SEA_CURSOR_STICK_TIME_MS

Referenced by TryBuildPondHitPosition(), and TryBuildSeaLevelHitPosition()

protected bool TryValidateHitCursor(PlayerBase player, vector playerPos, vector hitPosition, out vector resolvedHitPosition, out int resolvedLiquidType)

References HasClearPathToLiquidSurface(), IsCursorActuallyOnLiquidSurface(), IsNearlyZero()

Show 3 more

, TryGetNormalizedSeaHitPoint(), TryValidatePondHitPosition(), and m_AllowedLiquidSource

Referenced by TryResolveSyntheticCursor(), and TryUseCachedSyntheticCursor()

protected bool TryUseCachedSyntheticCursor(PlayerBase player, vector playerPos, vector currentHitPosition, out vector resolvedHitPosition, out int resolvedLiquidType)

Freshwater / pond path.

References CGame.GetTime(), IsCachedSyntheticCursorRelevant(), TryValidateHitCursor()

Show 5 more

, m_HasLastSyntheticHitCursor, m_LastSyntheticHitCursor, m_LastSyntheticHitCursorTime, SYNTHETIC_CURSOR_CACHE_MAX_AGE_MS, and vector.Zero

Referenced by TryResolveSyntheticCursor()

protected bool IsPositionNearCurrentCameraRay(vector position, float maxPerpendicularDistance)

Important: cached cursor must still match current aim.

References vector.DistanceSq(), vector.Dot(), CGame.GetCurrentCameraDirection()

Show 5 more

, CGame.GetCurrentCameraPosition(), vector.Normalize(), m_MaxActionDistance, SYNTHETIC_CURSOR_DISTANCE_BUFFER, and vector.Zero

Referenced by IsCachedSyntheticCursorRelevant()

protected bool IsCachedSyntheticCursorRelevant(vector currentHitPosition, vector cachedHitPosition)

Do not allow using a cached point far beyond the active aim range.

References vector.DistanceSq(), IsPositionNearCurrentCameraRay(), SYNTHETIC_CURSOR_CACHE_AIM_TOLERANCE

Show 1 more

, vector.Zero

Referenced by TryUseCachedSyntheticCursor()

protected bool IsAllowedPondLiquidSurface(vector playerPos, vector surfacePos, int liquidType)

If there is no real hit, compare cached point to current camera ray.

References Math.AbsFloat(), vector.Distance(), CGame.SurfaceIsPond()

Show 3 more

, m_AllowedLiquidSource, m_MaxActionDistance, and m_MaxVerticalReach

Referenced by TryBuildPondHitPosition(), and TryValidatePondHitPosition()

protected bool TryGetNonWaterSurfaceAt(vector probePosition, out vector surfacePosition)

References SurfaceInfo.GetLiquidType(), CGame.GetSurface(), SurfaceInfo.GetSurfaceType()

Show 8 more

, new SurfaceDetectionResult(), string.Empty, SurfaceDetectionResult.height, m_SurfaceDetectionParamsNoWater, SurfaceDetectionParameters.position, SurfaceDetectionParameters.rsd, SurfaceDetectionResult.surface, and vector.Zero

Referenced by IsCursorActuallyOnLiquidSurface()

protected bool IsCursorActuallyOnLiquidSurface(vector hitPosition, vector liquidSurfacePos)

Check if we have the same or an other liquid surface

References IsNearlyZero(), and TryGetNonWaterSurfaceAt()

Referenced by CheckSurfaceLiquid(), and TryValidateHitCursor()

override bool CanContinue(PlayerBase player, ActionTarget target)

If terrain/grass/road surface is higher, the player is aiming at ground over/near water, not the water itself.

References Can()

int GetLiquidType()

Re-validate during action

References m_LiquidType

Referenced by ActionDrinkPondContinuous.OnFinishProgressServer(), ActionObtainLiquidBase.ActionCondition(), and ActionObtainLiquidBase.SetupAction()

int GetWaterSourceType()

References m_WaterSourceType

Referenced by ActionFishingNew.ActionCondition()

int GetLiquidSourceType()

References m_LiquidSourceType

Referenced by ActionFishingNew.ActionCondition()

bool IsNearlyZero(vector value)

References vector.DistanceSq(), and vector.Zero

Referenced by CheckSurfaceLiquid(), DebugDrawSyntheticCursor(), IsCursorActuallyOnLiquidSurface()

Show 5 more

, IsValidTargetObject(), TryBuildPondHitPosition(), TryGetNormalizedSeaHitPoint(), TryValidateHitCursor(), and TryValidatePondHitPosition()

protected void ClearDebugCursorShapes()DIAG_DEVELOPER

References array.Clear(), array.Count(), Debug.RemoveShape()

Show 1 more

, m_DebugSyntheticCursorShapes

Referenced by DebugDrawSyntheticCursor(), and TryResolveSyntheticCursor()

protected void DebugDrawSyntheticCursor(PlayerBase player, vector originalHitPosition, vector cursorHitPosition, bool accepted, string reason, int liquidType = LIQUID_NONE)

DIAG_DEVELOPER

References ARGB(), DbgUI.Begin(), ClearDebugCursorShapes()

Show 16 more

, vector.Distance(), Debug.DrawLine(), Debug.DrawSphere(), DbgUI.End(), string.Format(), MiscGameplayFunctions.GetHeadBonePos(), Object.GetPosition(), array.Insert(), IsNearlyZero(), CGame.SurfaceIsPond(), CGame.SurfaceIsSea(), DbgUI.Text(), vector.ToString(), vector.ToString(), vector.ToString(), and m_DebugSyntheticCursorShapes

Referenced by TryResolveSyntheticCursor()