IsObjectBreakable: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Undo revision 50126 by Marcin778 (talk))
mNo edit summary
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Shared function}}
This function checks if an object is breakable.
 
{{New feature/item|3.0161|1.6.0|21765|Added also as a server-side function. Previously only available as a client-side function.}}
 
This function checks if an object / model ID is breakable.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">bool isObjectBreakable ( object theObject )</syntaxhighlight>  
<syntaxhighlight lang="lua">bool isObjectBreakable ( object theObject / int modelId )</syntaxhighlight>  
{{OOP||[[object]]:isBreakable|breakable|setObjectBreakable}}
{{OOP||[[object]]:isBreakable|breakable|setObjectBreakable}}
===Required Arguments===  
===Required Arguments===  
*'''object''' the [[object]] that's being checked.
*'''theObject / modelId:''' The [[object]] / model ID that's being checked.
===Returns===
===Returns===
* ''true'' if the object is breakable.
* ''true'' if the object is breakable.
Line 14: Line 17:
==Example==
==Example==
This example creates an object when the resource starts and checks if the object is breakable.
This example creates an object when the resource starts and checks if the object is breakable.
<syntaxhighlight lang="lua">addEventHandler("onClientResourceStart",resourceRoot,function()
<syntaxhighlight lang="lua">
local object = createObject ( 1337, 5540.6654, 1020.55122, 1240.545 )
addEventHandler("onClientResourceStart", resourceRoot, function()
if isObjectBreakable(object) then
    local object = createObject(1337, 5540.6654, 1020.55122, 1240.545)
outputChatBox("Yes, the object is breakable.")
    if isObjectBreakable(object) then
else
        outputChatBox("Yes, the object is breakable.")
outputChatBox("No, the object is not breakable")
    else
end
        outputChatBox("No, the object is not breakable")
    end
end)
end)
</syntaxhighlight>
</syntaxhighlight>

Latest revision as of 21:31, 16 April 2023

ADDED/UPDATED IN VERSION 1.6.0 r21765:
Added also as a server-side function. Previously only available as a client-side function.

This function checks if an object / model ID is breakable.

Syntax

bool isObjectBreakable ( object theObject / int modelId )

OOP Syntax Help! I don't understand this!

Method: object:isBreakable(...)
Variable: .breakable
Counterpart: setObjectBreakable


Required Arguments

  • theObject / modelId: The object / model ID that's being checked.

Returns

  • true if the object is breakable.
  • false if the object is not breakable.

Example

This example creates an object when the resource starts and checks if the object is breakable.

addEventHandler("onClientResourceStart", resourceRoot, function()
    local object = createObject(1337, 5540.6654, 1020.55122, 1240.545)
    if isObjectBreakable(object) then
        outputChatBox("Yes, the object is breakable.")
    else
        outputChatBox("No, the object is not breakable")
    end
end)

Requirements

Minimum server version n/a
Minimum client version 1.3.0-9.03783

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.3.0-9.03783" />

See Also