BreakObject: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{client function}}
{{client function}}
{{Needs_Example}}
This function breaks a specific object.
This function breaks a specific object.
Note: Only breakable objects can be broken.
Note: Only breakable objects can be broken.
Line 15: Line 14:
===Returns===
===Returns===
Returns ''true'' if the object was successfully broken. ''false'' if the object is not breakable, or a wrong object was given.
Returns ''true'' if the object was successfully broken. ''false'' if the object is not breakable, or a wrong object was given.
==Example==
This example checks if the object created is breakable and if it is then breaks it.
<syntaxhighlight lang="lua">
addCommandHandler("createObj",
function(command, id)
    local x, y, z = getElementPosition(localPlayer)
    local object = createObject (id, x, y, z)
    if (id) then
        if isObjectBreakable(object) then
            breakObject(object)
        end
    end
end
)
</syntaxhighlight>


==See Also==
==See Also==
{{Client_object_functions}}
{{Client_object_functions}}

Revision as of 16:50, 18 January 2014

This function breaks a specific object. Note: Only breakable objects can be broken.


[[{{{image}}}|link=|]] Note: This function does not support any kind of glass objects

Syntax

bool breakObject ( object theObject )

Required Arguments

Returns

Returns true if the object was successfully broken. false if the object is not breakable, or a wrong object was given.

Example

This example checks if the object created is breakable and if it is then breaks it.

addCommandHandler("createObj",
function(command, id)
    local x, y, z = getElementPosition(localPlayer)
    local object = createObject (id, x, y, z)
    if (id) then
        if isObjectBreakable(object) then
            breakObject(object)
        end
    end
end
)

See Also