ToggleObjectRespawn: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 10: Line 10:
bool toggleObjectRespawn ( object theObject, bool respawn )
bool toggleObjectRespawn ( object theObject, bool respawn )
</syntaxhighlight>
</syntaxhighlight>
 
{{OOP||[[object]]:toggleObjectRespawn}}
===Required Arguments===
===Required Arguments===
*'''theObject''': The object you want to toggle the respawn from
*'''theObject''': the object you want to toggle the respawn from
*'''respawn ''': A bool denoting whether we want to enable (''true'') or disable (''false'') respawning
*'''respawn ''': a bool denoting whether we want to enable (''true'') or disable (''false'') respawning


===Returns===
===Returns===
Returns ''true'' when the it was changed successfully, or ''false'' otherwise.
* ''true'' when the it was changed successfully.
* ''false'' otherwise.


==Example==
==Example==

Revision as of 23:05, 4 October 2014

This function is used to toggle if an object should respawn after it got destroyed

Syntax

bool toggleObjectRespawn ( object theObject, bool respawn )

OOP Syntax Help! I don't understand this!

Method: object:toggleObjectRespawn(...)


Required Arguments

  • theObject: the object you want to toggle the respawn from
  • respawn : a bool denoting whether we want to enable (true) or disable (false) respawning

Returns

  • true when the it was changed successfully.
  • false otherwise.

Example

This example adds command tos that toggles respawn of all the objects.

local respawn = false
addCommandHandler("tos",
	function ()
		for i, object in pairs(getElementsByType("object")) do
			toggleObjectRespawn(object, not respawn)
		end
		outputChatBox("Object respawning " .. (respawn and "disabled" or "enabled"))
		respawn = not respawn
	end)

See Also