⚙️Exports

List of exports to be called from external resources. All exports are client.

Current Exports

ExecuteHit

Export Function

exports('ExecuteHit', function(p1, p2, p3)
    return ExternalExecHit(p1, p2, p3)
end)

Example

Manually execute a hit against a ped. Requires a victim entity (p1), a shooter/suspect entity (p2), and a weapon hash (p3). None of the variables may be nil. With those 3 parameters, internally the script will fill in the blanks. Such as distance between victim & shooter/suspect, and damaged bone by the last damaged bone of the victim. The victim must be owned by the client who you're executing the hit with, or else GSW will cancel the hit.

Revive

Export Function

exports('Revive', function(p1)
    return PlayerRevivingThemself(p1)
end)

Example

Programical way to revive a entity. You need to manually ensure that the entity is deceased. Requires a deceased entity (p1). The deceased entity must be owned by the client who you're executing the hit with, or you will experience bugs. Death System and Player Self Revival must be enabled for the function to work.

ReviveNearest

Export Function

exports('ReviveNearest', function(p1)
    return PlayerRevivingAnother(p1)
end)

Example

Programical way to revive a entity, using a reference entity. You need to manually ensure that the entity is deceased. Requires a entity (p1) to use a reference. The deceased entity must be owned by the client who you're executing the hit with, or you will experience bugs. Death System must be enabled, and the client you pick to run this export must be allowed to revive others (defined under UE_Functions.lua), for the function to work.

RevivalOdds

Export Function

exports('RevivalOdds', function(p1)
    return GetRevivalChances(p1)
end)

Example

Returns a true or false value based on if the inputed entity should survive a revival or not. Odds are based on time since death, blood list, and the total severity of damages based on bone and weapon groups. The entity does not need to be deceased, but may cause unexpected behavior if called on an alive entity.

UpdateState

Export Function

exports('UpdateState', function(p1, p2, p3)
    return UpdateState(p1, p2, p3)
end)

Example

Updates a state for a entity, utilizing GSW's internal system for buffering. Requires the entity (p1), state name (p2), and new state value (p3).

FreshState

Export Function

exports('FreshState', function(p1)
    return FreshStateBag(p1)
end)

Example

Resets a entities (p1) statebag to default GSW values. This resets blood levels, wipes injuries, but it will not clear effects.

AddToDR

Export Function

exports('AddToDR', function(p1, p2, p3)
    return UpdateDRData(p1, p2, p3)
end)

Example

Adds a new entry to a entities damage record. Requires a entity (p1), a bone group index (p2) and a weapon group index (p3).

SetEntityPersistent

Export Function

exports('SetEntityPersistent', function(p1)
    return SetPedPersistent(p1)
end)

Example

Sets a onesync entity to be persistent throughout the map, allowing the client to access it at all times, and disabling despawning.

GetNearestDeadPedToEntity

Export Function

exports('GetNearestDeadPedToEntity', function(p1)
    return GetNearestPed(p1, true)
end)

Example

Gets the nearest dead entity to a reference entity. Requires the dead entity to be within the "NPMinDist" distance defined in config. If there is no entity within that distance, it will return nil.

GetNearestPedToEntity

Export Function

exports('GetNearestPedToEntity', function(p1)
    return GetNearestPed(p1, false)
end)

Example

Gets the nearest entity (dead or alive) to a reference entity. Requires the entity to be within the "NPMinDist" distance defined in config. If there is no entity within that distance, it will return nil.

GetLocalTimeFormatted

Export Function

exports('GetLocalTimeFormatted', function()
    return GetLocalTimeString()
end)

Example

Returns the local time as a string for printing.

GetBoneGroupData

Export Function

exports('GetBoneGroupData', function(p1)
    return LookupBoneGroup(p1)
end)

Example

Returns the bone group data for a bone group index (p1). Returns data such as Wound Severity, and Plain Text Print. Returns data as a table, directly from "BoneIndexerGroup" in config.

GetWeaponIndexData

Export Function

exports('GetWeaponIndexData', function(p1)
    return LookupWeaponIndex(p1)
end)

Example

Returns the weapon group data for a weapon group index (p1). Returns data such as Wound Severity, Plain Text Print, Fatal Headshot, and if the wound should have a impact. Returns data as a table, directly from "WeaponIndexerGroup" in config.

HardkillAllEffects

Export Function

exports('HardkillAllEffects', function(p1)
    return HardKillEffects(p1)
end)

Example

Terminates all active effects for a entity (p1) using GSW's Hardkill System. This will not reset movement clipset (drunk/injured walk), or reset statebags.

HardkillSpecificEffect

Export Function

exports('HardkillSpecificEffect', function(p1, p2)
    return SetIndividualHardkill(p1, p2)
end)

Example

Terminates a specific active effect (p2) for a entity (p1) using GSW's Hardkill System. This will not reset movement clipset (drunk/injured walk), or reset statebags. The active effect must be defined by Effect Ids.

DeathReset

Export Function

exports("DeathReset", function(p1)
    HardKillEffects(p1)
    ResetPedMovementClipset(p1, 0.0)
    FreshStateBag(p1)
end)

Example

A combined export to assist with compatability. Kills all effects, resets movement clipset, and gives the entity (p1) a fresh statebag. Should be used upon a revival event.

Deprecated Exports

Do not use these exports. They are unsupported, and may be removed in a future update.

CRGSW_ExecuteHit

Export Function

exports('CRGSW_ExecuteHit', function(p1, p2, p3)
    return ExternalExecHit(p1, p2, p3)
end)

Example

Manually execute a hit against a ped. Requires a victim entity (p1), a shooter/suspect entity (p2), and a weapon hash (p3). None of the variables may be nil. With those 3 parameters, internally the script will fill in the blanks. Such as distance between victim & shooter/suspect, and damaged bone by the last damaged bone of the victim. The victim must be owned by the client who you're executing the hit with, or else GSW will cancel the hit.

CRGSW_Revive

Export Function

exports('CRGSW_Revive', function(p1)
    return PlayerRevivingThemself(p1)
end)

Example

Programical way to revive a entity. You need to manually ensure that the entity is deceased. Requires a deceased entity (p1). The deceased entity must be owned by the client who you're executing the hit with, or you will experience bugs. Death System and Player Self Revival must be enabled for the function to work.

CRGSW_ReviveNearest

Export Function

exports('CRGSW_ReviveNearest', function(p1)
    return PlayerRevivingAnother(p1)
end)

Example

Programical way to revive a entity, using a reference entity. You need to manually ensure that the entity is deceased. Requires a entity (p1) to use a reference. The deceased entity must be owned by the client who you're executing the hit with, or you will experience bugs. Death System must be enabled, and the client you pick to run this export must be allowed to revive others (defined under UE_Functions.lua), for the function to work.

CRGSW_RevivalOdds

Export Function

exports('CRGSW_RevivalOdds', function(p1)
    return GetRevivalChances(p1)
end)

Example

Returns a true or false value based on if the inputed entity should survive a revival or not. Odds are based on time since death, blood list, and the total severity of damages based on bone and weapon groups. The entity does not need to be deceased, but may cause unexpected behavior if called on an alive entity.

CRGSW_UpdateState

Export Function

exports('CRGSW_UpdateState', function(p1, p2, p3)
    return UpdateState(p1, p2, p3)
end)

Example

Updates a state for a entity, utilizing GSW's internal system for buffering. Requires the entity (p1), state name (p2), and new state value (p3).

CRGSW_FreshState

Export Function

exports('CRGSW_FreshState', function(p1)
    return FreshStateBag(p1)
end)

Example

Resets a entities (p1) statebag to default GSW values. This resets blood levels, wipes injuries, but it will not clear effects.

CRGSW_AddToDR

Export Function

exports('CRGSW_AddToDR', function(p1, p2, p3)
    return UpdateDRData(p1, p2, p3)
end)

Example

Adds a new entry to a entities damage record. Requires a entity (p1), a bone group index (p2) and a weapon group index (p3).

CRGSW_SetEntityPersistent

Export Function

exports('CRGSW_SetEntityPersistent', function(p1)
    return SetPedPersistent(p1)
end)

Example

Sets a onesync entity to be persistent throughout the map, allowing the client to access it at all times, and disabling despawning.

CRGSW_GetNearestDeadPedToEntity

Export Function

exports('CRGSW_GetNearestDeadPedToEntity', function(p1)
    return GetNearestPed(p1, true)
end)

Example

Gets the nearest dead entity to a reference entity. Requires the dead entity to be within the "NPMinDist" distance defined in config. If there is no entity within that distance, it will return nil.

CRGSW_GetNearestPedToEntity

Export Function

exports('CRGSW_GetNearestPedToEntity', function(p1)
    return GetNearestPed(p1, false)
end)

Example

Gets the nearest entity (dead or alive) to a reference entity. Requires the entity to be within the "NPMinDist" distance defined in config. If there is no entity within that distance, it will return nil.

CRGSW_GetLocalTimeFormatted

Export Function

exports('CRGSW_GetLocalTimeFormatted', function()
    return GetLocalTimeString()
end)

Example

Returns the local time as a string for printing.

CRGSW_GetBoneGroupData

Export Function

exports('CRGSW_GetBoneGroupData', function(p1)
    return LookupBoneGroup(p1)
end)

Example

Returns the bone group data for a bone group index (p1). Returns data such as Wound Severity, and Plain Text Print. Returns data as a table, directly from "BoneIndexerGroup" in config.

CRGSW_GetWeaponIndexData

Export Function

exports('CRGSW_GetWeaponIndexData', function(p1)
    return LookupWeaponIndex(p1)
end)

Example

Returns the weapon group data for a weapon group index (p1). Returns data such as Wound Severity, Plain Text Print, Fatal Headshot, and if the wound should have a impact. Returns data as a table, directly from "WeaponIndexerGroup" in config.

CRGSW_HardkillAllEffects

Export Function

exports('CRGSW_HardkillAllEffects', function(p1)
    return HardKillEffects(p1)
end)

Example

Terminates all active effects for a entity (p1) using GSW's Hardkill System. This will not reset movement clipset (drunk/injured walk), or reset statebags.

CRGSW_HardkillSpecificEffect

Export Function

exports('CRGSW_HardkillSpecificEffect', function(p1, p2)
    return SetIndividualHardkill(p1, p2)
end)

Example

Terminates a specific active effect (p2) for a entity (p1) using GSW's Hardkill System. This will not reset movement clipset (drunk/injured walk), or reset statebags. The active effect must be defined by Effect Ids.

CRGSW_DeathReset

Export Function

exports("CRGSW_DeathReset", function(p1)
    HardKillEffects(p1)
    ResetPedMovementClipset(p1, 0.0)
    FreshStateBag(p1)
end)

Example

A combined export to assist with compatability. Kills all effects, resets movement clipset, and gives the entity (p1) a fresh statebag. Should be used upon a revival event.