SetObjectBreakable: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(OOP)
(Remove obsolete Requirements section)
 
(7 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{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}}
{{OOP||[[object]]:setBreakable|breakable|isObjectBreakable}}
===Required Arguments===  
===Required Arguments===  
*'''object''' the [[object]] that's being set.
*'''object''' the [[object]] that's being set.
*'''breakable''' a boolean whether the object is breakable(true) or unbreakable (false).
*'''breakable''' a boolean whether the object is breakable (true) or unbreakable (false).


===Returns===
===Returns===
Line 28: Line 31:
addEventHandler("onClientResourceStart", resourceRoot, toggleObjectVulnerability)
addEventHandler("onClientResourceStart", resourceRoot, toggleObjectVulnerability)
</syntaxhighlight>
</syntaxhighlight>
==Requirements==
 
{{Requirements|n/a|1.3.0-9.03783|}}
==See Also==
==See Also==
{{Client_object_functions}}
{{Client_object_functions}}

Latest revision as of 17:03, 7 November 2024

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