IsObjectBreakable: Difference between revisions

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" />

@@ Line 1: / Line 1: @@
 __NOTOC__
-{{Server 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==
-<syntaxhighlight lang="lua">object isObejectBreakable( object theObject )</syntaxhighlight>
+<syntaxhighlight lang="lua">bool isObjectBreakable ( object theObject / int modelId )</syntaxhighlight>
+{{OOP||[[object]]:isBreakable|breakable|setObjectBreakable}}
 ===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, else false if the object is not breakable.
+* ''true'' if the object is breakable.
+* ''false'' if the object is not breakable.
 ==Example==
-<section name="Client" class="client" show="true">
+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. (TESTED!)
+<syntaxhighlight lang="lua">
-<syntaxhighlight lang="lua">addEventHandler("onClientResourceStart",resourceRoot,function()
+addEventHandler("onClientResourceStart", resourceRoot, function()
-	local object = createObject ( 1337, 5540.6654, 1020.55122, 1240.545 )
+    local object = createObject(1337, 5540.6654, 1020.55122, 1240.545)
-	if isObjectBreakable(object) then
+    if isObjectBreakable(object) then
-		outputChatBox("Yes, the object is breakable.")
+        outputChatBox("Yes, the object is breakable.")
-	else
+    else
-		outputChatBox("No, the object is not breakable")
+        outputChatBox("No, the object is not breakable")
-	end
+    end
 end)
 </syntaxhighlight>
-</section>
+==Requirements==
+{{Requirements|n/a|1.3.0-9.03783|}}
 ==See Also==
-{{Object functions}}
+{{Client_object_functions}}