DIFF

class MiscGameplayFunctions

Constants 1
static const float OBJECT_OBSTRUCTION_MIN_DISTANCE_SQ = 0.0625

squared distance below which an obstruction raycast is pointless, nothing can fit in between [default 0.25m]

Referenced by IsObjectObstructedFilterEx()

Methods 89
static float Truncate(float value, int decimals = 2)

truncate float to specified precision

References Math.Clamp(), Math.Floor(), Math.Pow()
Show 2 more, float.LOWEST, and float.MAX
Referenced by TruncateToS()
static vector TruncateVec(vector value, int decimals = 2)

truncate float to specified precision

References Math.Clamp(), Math.Floor(), Math.Pow()
Show 3 more, Vector(), float.LOWEST, and float.MAX
Referenced by MissionGameplay.UpdateDebugMonitor()
static string TruncateVecToS(vector value, int decimals = 2, string delimiter = " ")
References TruncateToS()
Referenced by CameraToolsMenu.Update()
static string ValueToBar(float value, string bar = "[----------]", string mark = "x")

Produces ACII "progress bar" based on an 0..1 'value' input

References Math.Clamp(), InsertAtPos(), string.Length()
Show 2 more, Math.Lerp(), and Math.Round()
Referenced by HudDebugWinCharLevels.SetValues()
static string InsertAtPos(string base, string insert, int pos)

Insert 'insert' behind index 'pos' of the 'base' string

References string.Length(), and string.Substring()
Referenced by ValueToBar()
static void TransferItemProperties(EntityAI source, notnull EntityAI target, bool transfer_agents = true, bool transfer_variables = true, bool transfer_health = true, bool exclude_quantity = false)

will transform variables, agents and other local scripted properties as well as any relevant non-scripted properties like health

References Class.Cast(), EntityAI.GetAgents(), CGame.IsMultiplayer()
Show 4 more, CGame.IsServer(), ItemBase.TransferAgents(), TransferEntityHealth(), and TransferEntityVariables()
Referenced by ActionBreakLongWoodenStick.OnFinishProgressServer(), ActionCollectBloodTargetLambda.CopyOldPropertiesToNew(), ActionCoverHeadSelf.OnFinishProgressServer(), and 65 more
static void TransferItemVariables(ItemBase source, ItemBase target, bool exclude_quantity = false)

DEPRECATED

References TransferEntityVariables()
static void TransferEntityHealth(EntityAI source, EntityAI target, array<string> healthTypes = null, bool transferZoneDamage = true)
References array.Copy(), array.Count(), array.Find()
Show 5 more, Object.GetDamageZones(), Object.GetDamageZones(), Object.GetHealth01(), array.Insert(), and Object.SetHealth01()
Referenced by TransferItemProperties()
static void TurnItemIntoItem(notnull ItemBase old_item, string new_item_type, notnull PlayerBase player)
References TurnItemIntoItemEx(), and new TurnItemIntoItemLambda()
Referenced by Barrel_ColorBase.BleachClothes()
static void TurnItemInHandsIntoItem(notnull ItemBase old_item, string new_item_type, notnull PlayerBase player)
References TurnItemInHandsIntoItemEx(), and new TurnItemIntoItemLambda()
static array<ItemBase> CreateItemBasePiles(string item_name, vector ground_position, float quantity, float health, bool floaty_spawn = false)

Spawns multiple piles of stackable ItemBase objects on ground (intended for generic use)

References CreateItemBasePilesEx()
static array<ItemBase> CreateItemBasePilesEx(string itemName, vector groundPosition, float quantity, float health, bool floatySpawn = false, bool throwAfterSpawn = false)
References Class.Cast(), CGame.ConfigGetInt(), CGame.CreateObjectEx()
Show 6 more, Math.Floor(), array.Insert(), Object.SetHealth(), ItemBase.SetQuantity(), InventoryItem.ThrowPhysically(), and vector.Zero
Referenced by CreateItemBasePiles(), and StaticConstructionMethods.SpawnConstructionMaterialPilesEx()
static array<ItemBase> CreateItemBasePilesDispersed(string item_name, vector starPos, vector targetPos, float radius, float quantity, float health, Object ignoreObjectCollison)

creation method using raycast-dispersed positioning; ECE_TRACE not used as a result

References Class.Cast(), CGame.ConfigGetInt(), CGame.CreateObjectEx()
Show 5 more, Math.Floor(), GetRandomizedPositionVerified(), array.Insert(), Object.SetHealth(), and ItemBase.SetQuantity()
Referenced by ConstructionPartRebuildRubble.SpawnRubbleMaterials(), CraftTannedLeather.Do(), and StaticConstructionMethods.SpawnConstructionMaterialPilesEx()
static array<Magazine> CreateMagazinePiles(string item_name, vector ground_position, float quantity, float health)
References Class.Cast(), CGame.ConfigGetInt(), CGame.CreateObjectEx()
Show 3 more, Math.Floor(), array.Insert(), and Magazine.ServerSetAmmoCount()
static array<Magazine> CreateMagazinePilesDispersed(string item_name, vector starPos, vector targetPos, float radius, float quantity, float health, Object ignoreObjectCollison)

creation method using raycast-dispersed positioning; ECE_TRACE not used as a result

References Class.Cast(), CGame.ConfigGetInt(), CGame.CreateObjectEx()
Show 4 more, Math.Floor(), GetRandomizedPositionVerified(), array.Insert(), and Magazine.ServerSetAmmoCount()
Referenced by ActionEmptyMagazine.OnExecuteServer(), and CreateMagazinePilesFromBulletDispersed()
static array<Magazine> CreateMagazinePilesFromBullet(string bullet_type, vector ground_position, float quantity, float health)
References Class.Cast(), CGame.ConfigGetInt(), CGame.ConfigGetText()
Show 4 more, CGame.CreateObjectEx(), Math.Floor(), array.Insert(), and Magazine.ServerSetAmmoCount()
static array<Magazine> CreateMagazinePilesFromBulletDispersed(string bullet_type, vector starPos, vector targetPos, float radius, float quantity, float health, Object ignoreObjectCollison)
References CGame.ConfigGetText(), and CreateMagazinePilesDispersed()
Referenced by ActionEmptyMagazine.OnExecuteServer()
static int GetHealthLevelForAmmo(string class_name, float health)
References array.Clear(), CGame.ConfigGetFloatArray(), array.Count()
Show 2 more, array.Get(), and CachedObjectsArrays.ARRAY_FLOAT
Referenced by ActionSortAmmoPile.SortAmmo()
static bool GetProjectedCursorPos3d(out vector position, Weapon_Base weapon)
References Object.GetSelectionPositionMS(), Object.ModelToWorld(), vector.Normalized()
Show 1 more, DayZPhysics.RaycastRV()
static float GetPlayerHeadHeight(notnull PlayerBase player)

Returns approximated height(from terrain) of head in WS which takes the player's stance into account Preferred method over GetHeadBonePos variant which can be expensive on perf

player
Reference to player entity
References DayZPlayer.IsPlayerInStance(), PlayerConstants.HEAD_HEIGHT_CROUCH, PlayerConstants.HEAD_HEIGHT_ERECT
Show 1 more, PlayerConstants.HEAD_HEIGHT_PRONE
Referenced by GetPlayerHeadPosition(), and VicinityItemManager.GetFixedHeadHeightAdjustment()
static bool IsValueInRange(float value, float from, float to)
Referenced by BreathVapourMdfr.OnTick()
static bool IsPlayerOrientedTowardPos(notnull DayZPlayerImplement player, vector target_pos, float cone_angle)

Check if player direction(based on cone of defined angle) is oriented to target position

References Math.AbsFloat(), Math.Acos(), vector.Dot()
Show 5 more, Object.GetDirection(), Object.GetPosition(), vector.Normalize(), vector.Normalize(), and Math.RAD2DEG
Referenced by FlashGrenade.OnExplosionEffects()
static string SanitizeString(string input)

dir in cone or in a tip of cone

References Math.Clamp(), string.Length(), and string.Substring()
Referenced by NoteMenu.OnClick(), and WrittenNoteData.SetNoteText()
static bool MemPointDirectionalCheck(PlayerBase player, EntityAI targetEnt, string memPointStartName, string memPointEndName, float toleranceAngle = Math.PI_HALF)

Returns true when the player stands on the opposite side of memPointEndName relative to memPointStartName (angle exceeds toleranceAngle) Intentionally returns true (no restriction) when the check cannot be performed (missing player/entity or memory points) Callers where a failed check must deny access have to verify the preconditions (e.g. MemoryPointExists) themselves

References vector.Direction(), GenericDirectionalCheck(), Object.GetMemoryPointPos()
Show 6 more, GetPlayerHeadPosition(), Object.GetPosition(), Object.MemoryPointExists(), Object.ModelToWorld(), vector.Normalize(), and vector.Normalize()
Referenced by BuildingBase.DoorsDirectionalCheck(), Bunker.CanDoorBeOpened(), ConstructionBase.ConstructionDirectionCheck()
Show 2 more, DigitalCodeLock.CanDetachCodeLock(), and DigitalCodeLock.IsPlayerOnBackside()
static bool GenericDirectionalCheck(vector dir1, vector dir2, float toleranceAngle)

just compares the angle

References Math.Acos()
Referenced by MemPointDirectionalCheck()
static void IsUnderRoofFromToCalculation(EntityAI entity, out vector from, out vector to, float height = GameConstants.ROOF_CHECK_RAYCAST_DIST)
References Object.GetCollisionBox(), Object.GetPosition(), EntityAI.HeightCheckOverride()
Show 2 more, EntityAI.HeightStartCheckOverride(), and Vector()
Referenced by Hologram.IsClippingRoof(), IsUnder(), and IsUnderRoofEx()
static bool IsUnderRoofEx(EntityAI entity, float height = GameConstants.ROOF_CHECK_RAYCAST_DIST, int geometry = ObjIntersectView)
References IsUnderRoofFromToCalculation(), and DayZPhysics.RaycastRV()
Referenced by FireworksBase.CanBeIgnitedBy(), Hologram.IsClippingRoof(), and IsUnderRoof()
static bool IsUnder(EntityAI entity, array<typename> excludedTypes, out Object hitObj, float height = GameConstants.ROOF_CHECK_RAYCAST_DIST, int geometry = ObjIntersectIFire)
References array.Count(), set.Count(), set.Get()
Show 3 more, Class.IsInherited(), IsUnderRoofFromToCalculation(), and DayZPhysics.RaycastRV()
Referenced by ScriptedSandstormController.ApplyBuildingCheckModifier()
static vector GetRandomizedPosition(vector targetPos, float radius)
References Math.Cos(), Math.RandomFloat01(), Math.RandomIntInclusive()
Show 2 more, Math.Sin(), and Vector()
Referenced by GetRandomizedPositionVerified()
static vector GetRandomizedPositionVerifiedPlayer(Man player, float distance, float radius, Object ignore)
References Class.Cast(), Object.GetDirection(), GetPlayerHeadPosition()
Show 2 more, Object.GetPosition(), and GetRandomizedPositionVerified()
Referenced by PlayerBase.SpawnEntityOnGroundRaycastDispersed()
static void ThrowAllItemsInInventory(notnull EntityAI parent, int flags)
References GetVelocity(), and ThrowAllItemsInInventoryEx()
Referenced by BarrelHoles_ColorBase.OnItemFallRebuilding(), and Fireplace.EOnPostSimulate()
static void FilterObstructingObjects(array<Object> potentiallyObstructingObjects, out array<Object> obstructingObjects)

apply factors

References Object.CanObstruct(), Object.CanProxyObstruct(), array.Count()
Show 1 more, array.Insert()
Referenced by ActionTargets.FilterObstructedObjectsEx(), and VicinityItemManager.RefreshVicinityItems()
static void FilterObstructedObjectsByGrouping(vector origin, float range, float distanceDelta, array<Object> objects, array<Object> obstructingObjects, out array<Object> filteredObjects, bool doDistanceCheck = false, bool checkIfDistanceCanBeIgnored = false, float maxDist = 0)

filters out objects obstructed from 'origin' by a raycast per object

References CanIgnoreDistanceCheck(), IsObjectObstructedCache.ClearCache(), array.Count()
Show 5 more, vector.DistanceSq(), Object.GetPosition(), array.Insert(), new IsObjectObstructedCache(), and IsObjectObstructedEx()
Referenced by ActionTargets.FilterObstructedObjectsEx(), and VicinityItemManager.RefreshVicinityItems()
static void SplitArrayIntoGroupsByDistance(array<Object> objects, array<ref array<Object>> objectGroups, float squaredDistanceDelta)
References array.Count(), vector.DistanceSq(), Object.GetWorldPosition()
Show 4 more, Object.GetWorldPosition(), array.Insert(), array.Insert(), and array.Remove()
static bool IsObjectObstructed(Object object, bool doDistanceCheck = false, vector distanceCheckPos = "0 0 0", float maxDist = 0)
References Class.Cast(), CGame.GetPlayer(), GetPlayerHeadPosition()
Show 2 more, new IsObjectObstructedCache(), and IsObjectObstructedEx()
Referenced by VicinityItemManager.IsObstructed()
static bool IsObjectObstructedFilter(Object object, IsObjectObstructedCache cache, PlayerBase player)
References Object.CanObstruct(), set.Count(), set.Get()
Show 1 more, IsObjectObstructedCache.HitObjects
static float Normalize(int val, int maxVal)
References Debug.LogError()
Referenced by FlareSimulation.Simulate(), and ShockHandler.ShockHitEffect()
static float Bobbing(float period, float amplitude, float elapsedTime)
References FModulus(), and Math.Sin()
Referenced by ShockHandler.AddEffectBobbing()
static float FModulus(float x, float y)
References Math.ModFloat()
Referenced by Bobbing()
static void TeleportCheck(notnull PlayerBase player, notnull array<ref array<float>> safe_positions)

checks if we should teleport the player to a safe location and if so, performs the teleportation

References Class.Cast(), GetClosestSafePos(), Man.GetIdentity()
Show 9 more, GetPlugin(), Object.GetPosition(), Entity.GetSimulationTimeStamp(), PlayerBase.IsPersistentFlag(), PluginAdminLog.PlayerTeleportedLog(), CGame.RPCSingleParam(), PlayerBase.SetPersistentFlag(), Object.SetPosition(), and CGame.SurfaceY()
Referenced by AreaExposureMdfr.OnActivate()
static vector GetClosestSafePos(vector to_pos, notnull array<ref array<float>> positions)
References vector.DistanceSq(), and float.MAX
Referenced by TeleportCheck()
static bool TeleportPlayerToSafeLocation3D(notnull PlayerBase player, vector safePos)

'stupider' teleport method, does not touch flag management. Applies Y from the position as well!

References Man.GetIdentity(), Object.GetPosition(), CGame.RPCSingleParam()
Show 1 more, Object.SetPosition()
Referenced by PlayerBase.AfterStoreLoad()
static void GenerateAINoiseAtPositionEx(notnull Object source, float lifeTime, NoiseParams noiseParams)
References NoiseSystem.AddNoiseTarget(), CGame.GetNoiseSystem(), Object.GetPosition()
Show 1 more, CGame.IsServer()
Referenced by FlareSimulation.CastFlareAINoise()
static int GetComponentIndex(array<Selection> pSelection, string pCompName)
References array.Count(), Selection.GetName(), IsComponentInSelection()
Show 1 more, string.ToLower()
static void DeleteAttachedChildrenByTypename(notnull EntityAI parent, array<typename> listOfTypenames)
References Class.Cast(), array.Count(), Object.Delete()
Show 4 more, IEntity.GetChildren(), IEntity.GetSibling(), Object.IsAnyInherited(), and IEntity.RemoveChild()
Referenced by SpookyArea23.OnPlayerExitServer()
static void GetAttachedChildren(IEntity parent, array<IEntity> outputObjects)

Fills the provided array with all children entities in hierarchy of this entity

References IEntity.GetChildren(), IEntity.GetSibling(), and array.Insert()
static void SoakItemInsideParentContainingLiquidAboveThreshold(notnull ItemBase item, notnull ItemBase parent, float liquidQuantityThresholdPercentage = 0.05)
References EntityAI.GetIsFrozen(), ItemBase.GetLiquidType(), ItemBase.GetQuantityNormalized()
Show 2 more, CGame.IsServer(), and ItemBase.SetWetMax()
Referenced by Barrel_ColorBase.EECargoIn(), Barrel_ColorBase.OnFreezeStateChangeServer(), Bottle_Base.EECargoIn()
Show 1 more, Bottle_Base.OnFreezeStateChangeServer()
static bool ComponentIdxContainsSelection(Object obj, int compIdx, string selName)
References string.Contains(), and Object.GetActionComponentNameList()
static bool BuildCondition(PlayerBase player, ActionTarget target, ItemBase item, bool camera_check)
Referenced by ComplexBuildCollideCheckClient()
static void GenerateAINoiseAtPosition(vector position, float lifeTime, NoiseParams noiseParams)
References NoiseSystem.AddNoiseTarget(), GetGame(), CGame.GetNoiseSystem()
Show 1 more, CGame.IsServer()