SA:O APIObject fracture effects

Returns an armed object's remaining durability.

Syntax

Copy signature

float|false getObjectBreakHealth(object theObject)

Arguments

theObjectobject

Streamed object element.

Returns

The remaining health, or false when the object has no profile.

Ownership and lifecycle

A break effect belongs to the resource that created it and is removed when that resource stops. Fragment geometry is cached per model, so repeated fractures of the same model reuse the first computed cut until the cache is cleared.

Where this comes from

SOURCECLuaBreakEffectDefs.cppClient/mods/deathmatch/logic/luadefs/CLuaBreakEffectDefs.cpp INTRODUCED / EXTENDED418f250d6Read the commit and why the change was made TEST RESOURCE break-test test-resources/break-test

RELATED SA:O APIS

Continue exploring

Read the system guide →

createObjectBreakEffect Fractures a streamed object into fragments cut from its own live geometry. setObjectBreakProfile Gives an object durability so ordinary GTA damage fractures it on its own. getObjectBreakProfile Returns the durability profile armed on an object.

← Previous in categoryclearObjectBreakProfile Next in category →setObjectBreakHealth

← Back to the SA:O Lua API · How Object fracture effects works →