SetObjectBreakable: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
Fernando187 (talk | contribs) (Remove obsolete Requirements section) |
||
| (10 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{ | {{Shared function}} | ||
{{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 sets an object to be breakable/unbreakable. | This function sets an object to be breakable/unbreakable. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool setObjectBreakable ( object theObject, bool breakable )</syntaxhighlight> | <syntaxhighlight lang="lua">bool setObjectBreakable ( object theObject, bool breakable )</syntaxhighlight> | ||
{{OOP||[[object]]:setBreakable|breakable|isObjectBreakable}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
*'''object''' | *'''object''' the [[object]] that's being set. | ||
*'''breakable''' | *'''breakable''' a boolean whether the object is breakable (true) or unbreakable (false). | ||
===Returns=== | ===Returns=== | ||
* ''true'' if the object is now breakable. | |||
* ''false'' if it can't or if invalid arguments are passed. | |||
==Example== | ==Example== | ||
This example creates an object when the resource starts and sets it to be breakable. | This example creates an object when the resource starts and sets it to be breakable. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua">function toggleObjectVulnerability() | ||
local object = createObject ( 1337, 5540.6654, 1020.55122, 1240.545 ) | local object = createObject(1337, 5540.6654, 1020.55122, 1240.545) | ||
if setObjectBreakable(object,true) | if isObjectBreakable(object) then | ||
setObjectBreakable(object, false) | |||
outputChatBox("The object is now not breakable.") | |||
else | |||
setObjectBreakable(object, true) | |||
outputChatBox("The object is now breakable.") | outputChatBox("The object is now breakable.") | ||
end | end | ||
end) | end | ||
addEventHandler("onClientResourceStart", resourceRoot, toggleObjectVulnerability) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{Client_object_functions}} | {{Client_object_functions}} | ||
Latest revision as of 17:03, 7 November 2024
This function sets an object to be breakable/unbreakable.
Syntax
bool setObjectBreakable ( object theObject, bool breakable )
OOP Syntax Help! I don't understand this!
- Method: object:setBreakable(...)
- Variable: .breakable
- Counterpart: isObjectBreakable
Required Arguments
- object the object that's being set.
- breakable a boolean whether the object is breakable (true) or unbreakable (false).
Returns
- true if the object is now breakable.
- false if it can't or if invalid arguments are passed.
Example
This example creates an object when the resource starts and sets it to be breakable.
function toggleObjectVulnerability()
local object = createObject(1337, 5540.6654, 1020.55122, 1240.545)
if isObjectBreakable(object) then
setObjectBreakable(object, false)
outputChatBox("The object is now not breakable.")
else
setObjectBreakable(object, true)
outputChatBox("The object is now breakable.")
end
end
addEventHandler("onClientResourceStart", resourceRoot, toggleObjectVulnerability)
See Also
- createObject
- getObjectScale
- moveObject
- setObjectScale
- stopObject
- getObjectMass
- getObjectProperty
- setObjectMass
- setObjectProperty