Internal API | Calebs Realism

Example

DoBlackoutToPed(targetEntity, weaponData, boneData, hitId)

Arguments targetEntity,weaponData,boneData,hitId Description Triggers the effect "Blackout" against the target entity. Function Info Client sided function. Not immediately threaded after call.

Example

DoBleedoutToPed(targetEntity, weaponData, boneData, drawBlood, localizedHitCoords, hitId)

Arguments targetEntity,weaponData,boneData,drawBlood,localizedHitCoords,hitId Description Triggers the effect "Bleedout" against the target entity. Function Info Client sided function. Not threaded at all.

Example

local pendingDecals = GetPendingDecals()

Description Returns a table of pending decals for blood on the ground. This table is used to avoid network overflows, by queing all the decal positions and sending multiple at once. Function Info Client sided function. Not threaded at all.

Example

local bleedingEnts = GetBleedingEntities()

Description Returns a table of all entities that are actively bleeding. This table is indexed by entity net id, and the value is all of the entities Bleed Data Function Info Client sided function. Not threaded at all.

Example

ClearEntityBleedingWounds(entity)

Arguments

entity Description Clears all bleeding wounds of an entity, stopping the effect for the entity. Function Info Client sided function. Not threaded at all.

Example

ClearEntityBleedingWound(entity)

Arguments

entity Description Clears a single bleeding wound of a entity, either slowing blood loss, or ending blood loss. Function Info Client sided function. Not threaded at all.

Example

DoBoneFractureToPed(targetEntity, weaponData, boneData, hitId)

Arguments targetEntity,weaponData,boneData,hitId Description Triggers the effect "Bone Fracture" against the target entity. Function Info Client sided function. Not immediately threaded after call. This effect only effects players.

Example

DoConcussionToPed(targetEntity, weaponData, hitId)

Arguments targetEntity,weaponData,hitId Description Triggers the effect "Concussion" against the target entity. Function Info Client sided function. Not immediately threaded after call.

Example

DoDamageToPed(targetEntity, weaponData, boneData, distance, armorData, armorActive, hitId)

Arguments targetEntity,weaponData,boneData, distance, armorData, armorActive,hitId Description Triggers the effect "Damage" against the target entity. Function Info Client sided function. Not immediately threaded after call.

Example

DoParalyzationToPed(targetEntity, weaponData, nil, hitCoords, hitId)

Arguments targetEntity,weaponData,hitCoords,hitId Description Triggers the effect "Paralyzation" against the target entity. Function Info Client sided function. Not immediately threaded after call.

Example

DoRagdollToPed(targetEntity, weaponData, boneData, armorData, armorActive, hitId)

Arguments targetEntity,weaponData,boneData, armorData, armorActive,hitId Description Triggers the effect "Ragdoll" against the target entity. Function Info Client sided function. Not immediately threaded after call.

Example

DoShockToPed(targetEntity, weaponData, nil, hitId)

Arguments targetEntity,weaponData,hitId Description Triggers the effect "Shock" against the target entity. Function Info Client sided function. Not immediately threaded after call.

Example

DoTBIToPed(targetEntity, weaponData, boneData, hitId)

Arguments targetEntity,weaponData,boneData,hitId Description Triggers the effect "TBI" against the target entity. Function Info Client sided function. Not immediately threaded after call.

Example

TriggerTunnelVision(targetEntity, weaponIndex, boneGroup, hitId)

Arguments targetEntity,weaponIndex,boneGroup,hitId Description Triggers the effect "TunnelVision" against the target entity. Function Info Client sided function. Not immediately threaded after call.

Example

HardKillEffects(targetEntity)

Arguments targetEntity Description Terminates all active effects on the entity. This will also terminate visual effects and camera shaking, but not injured walking. Alternatively, you can use the export HardkillAllEffects to call this externally. Function Info Client sided function. Not threaded.

Example

SetIndividualHardkill(targetEntity, effectId)

Arguments targetEntity,effectId Description Terminates a specific effect on the entity. This will not terminate visual effects, camera shaking, or injured walking. Alternatively, you can use the export HardkillSpecificEffect to call this externally. Function Info Client sided function. Not threaded.

Example

SearchThreads(targetEntity, effectId)

Arguments targetEntity,effectId Description Used to terminate effect threads. This will not terminate bleedout, as bleedout uses it owns threading system separate from the rest of the effects. Function Info Client sided function. Not threaded. This method is depreceated. Though in use, is due to be removed.

Example

InsertThread(targetEntity, effectId, threadId)

Arguments targetEntity,effectId,threadId Description Used to register threads from ((REF CRTHREAD)) to HardKills memory. This is automatically done when a new ((REF CRTHREAD)) is created. Function Info Client sided function. Not threaded. This method is depreceated. Though in use, is due to be removed.

Example

local threads = GetAllActiveThreads()

Description Returns all threads HardKill has registered. Function Info Client sided function. Not threaded. This method is depreceated. Though in use, is due to be removed.

Example

local ped = GetNearestPed(referenceEntity, shouldBeDead)

Arguments referenceEntity , shouldBeDead Description Returns the nearest entity to a reference entity. This entity must be within "NPMinDist" (under Config) from the reference entity. Alternatively, you can use GetNearestPedToEntity or GetNearestDeadPedToEntity exports to call this function externally. Will return nil if there is no nearby entity. Function Info Client sided function. Not threaded.

Example

local ped = GetNearestPedToCoords(ignoredPed, referenceCoords, shouldBeDead)

Arguments ignoredPed , referenceCoords , shouldBeDead Description Returns the nearest entity to the reference coords. This entity must be within "NPMinDist" (under Config) from the reference coords. Will return nil if there is no nearby entity. Function Info Client sided function. Not threaded.

Example

local veh = GetNearestMedicalVehicle(someEntity)

Description Returns the nearest vehicle defined in Datasets/StandaloneSpecific/Vehicles.lua Has a non-configurable minimum distance of 10. Function Info Client sided function. Not threaded.

Example

local boneGroupData = LookupBoneGroup(boneGroup)

Arguments boneGroup Description Returns the data defiend under "BoneIndexerGroup" (in Config) for the bone group. Alternatively, you can use the GetBoneGroupData export to call this externally. Function Info Client sided function. Not threaded.

Example

local weaponIndexData = LookupWeaponIndex(weaponIndex)

Arguments weaponIndex Description Returns the data defiend under "WeaponIndexerGroup" (in Config) for the weapon index. Alternatively, you can use the GetWeaponIndexData export to call this externally. Function Info Client sided function. Not threaded.

Example

print(GetLocalTimeString())

Description Returns the local UTC time as a string. Alternatively, you can use GetLocalTimeFormatted export to call this function externally. Function Info Client sided function. Not threaded.

Example

local coords = GetGroundCoordsAtEntity(entity)

Arguments entity Description Returns the ground coords for a entity, or the entities coords if native failed. Function Info Client sided function. Not threaded.

Example

SetPlayerDrunkShake(entity, intensity)

Arguments entity , intensity Description Sets the players screen shake to drunk. Function will verify the entity is the playerPed. Function Info Client sided function. Not threaded.

Example

SetPedChancedRagdoll(entity, chance, timings)

Arguments entity , chance , timings Description Sets the entity to have a chance and random durationed ragdoll. Function Info Client sided function. Not threaded.

Example

Localize(string, keys, values)

local locString = Localize("Dummy string {W} replace{A}", {"W", "A"}, {"a", "."})

local locString = Localize("{A} should use the localization table.", {
"A"}, {19})

Arguments string , keys , values Description Localizes a string of text, or replaces multiple values. Keys are a table {} of multiple terms to search for, while values are what to replace that with. Values may be a string for declared replacement, while numbers reference the localization table inside of the Config file. Function Info Client sided function. Not threaded.

Example

Localization(localizationTableKey, keys, values)

local locString = Localization(15, {"You/Them"}, {19})

Arguments localizationTableKey , keys , values Description Localizes a string of text, or replaces multiple values. While like Localize, this one will not accept a string input, but rather a integer to point to localization table inside of the Config file. Keys are a table {} of multiple terms to search for, while values are what to replace that with. Values may be a string for declared replacement, while numbers reference the localization table inside of the Config file. Function Info Client sided function. Not threaded.

Example

NLOCAL(localizationTableKey, keys, values)

NLOCAL(15, {"You/Them"}, {19})

Arguments localizationTableKey , keys , values Description Localizes a string of text, or replaces multiple values, and sends it to CF_NOTIFY(). While like Localize and Localization, this one will not return any value, but directly notify the client. Additionally, keys and values may be nil. Keys are a table {} of multiple terms to search for, while values are what to replace that with. Values may be a string for declared replacement, while numbers reference the localization table inside of the Config file. Function Info Client sided function. Not threaded.

Example

GetWeaponInfo(weaponHash)

local weaponInfo = GetWeaponInfo(weaponHash)
print(weaponInfo.Hash, weaponInfo.Index)

Arguments weaponHash Description Returns the hash, and the weapon group index. Function Info Client sided function. Not threaded.

Example

GetWeaponData(weaponHash, weaponInfo)

local weaponData = GetWeaponData(weaponHash, weaponInfo)

Arguments weaponHash , weaponInfo Description Returns the Weapon Data of a weapon hash. Function Info Client sided function. Not threaded.

Example

GetBoneData(boneIndexNumber)

local boneData = GetBoneData(boneIndexNumber)

Arguments boneIndexNumber Description Returns the Bone Data of a bone index. Function Info Client sided function. Not threaded.

Example

GetArmorData(entity)

local armorData = GetArmorData(entity)
local body = armorData.Body
local helmet = armorData.Helmet

Arguments entity Description Returns the Armor Data of a entity. Function Info Client sided function. Not threaded.

Example

local vehicleData = RequestVehicle(vehicleModelHash)

Arguments vehicleModelHash Description Returns the data from Datasets/StandaloneSpecific/Vehicles.lua for the specific model hash. Function Info Client sided function. Not threaded.

Example

local medicalData = RequestMedicalTable("HEADREST-IFAK")

Arguments string/medical item name Description Returns the data from Datasets/StandaloneSpecific/Medical.lua for the specific medical item. Function Info Client sided function. Not threaded.

Example

ColoredPrint(string, color)
ColoredPrint("Warning", "yellow")

Arguments string , color Description Prints a colored string to the console. Function Info Client sided function. Not threaded.

Example

SetPedPersistent(entity)

Arguments entity Description Sets the entity to be persistent on onesync servers. Function Info Client sided function. Not threaded.

🍏Internal API

This section is unfinished, please be patient.

Functions in Effects/

Blackout.lua

Bleedout.lua

BoneFracture.lua

Concussion.lua

Damage.lua

Paralyzation.lua

Ragdoll.lua

Shock.lua

TBI.lua

TunnelVision.lua

Functions in Systems/

ClientUtils/

Hardkill.lua

MiscFunctions.lua