StopObject

From Multi Theft Auto: Wiki
Revision as of 03:07, 12 April 2007 by Ransom (talk | contribs) (→‎Example)
Jump to navigation Jump to search
Dialog-information.png This article needs checking.

Reason(s): This had stuff put by someone else that said it stops elements but its called stopobject so I wrote it for objects and see also is defined as object category. Not sure? --Ransom 20:54, 11 April 2007 (CDT)


This will allow you to stop an object that is currently moving.

Syntax

bool stopObject ( object theobject )

Required Arguments

  • theobject: This is the object whose movement you wish to stop

Returns

Returns true if successful, false otherwise.

Example

This will allow you to toggle the random movement of a staircase object model and stop it immediately with the stopObject command.

addCommandHandler ( "toggleobjectmove", "objectMoveControl" )
function objectMoveControl ( player, commandName, state )
--On "toggleobjectmove" in console, activate this command, which
--also asks the player to define the value for the varible 'state'. 
	if state == "on" then
	outputChatBox ( "Moving object randomly" )
	mytimer = setTimer ( "randomObjectMovement", 2250, 0 )
	--if player types "on" for the state varible, turn on the timer,
	--which triggers the function randomObjectMovement that makes
        --the object move in random directions. The timer runs every 2 1/4
        --seconds for 0 times, which means it runs infintely.
	elseif state == "off" then
	outputChatBox ( "Stopping object movement" )
	killTimer ( mytimer )
	stopObject ( myobject )
	--If player typed "off" for state, stop the object movement
	--immediately and kill the random object movement timer, which
	--triggers the randomObjectMovement function (not included in 
        --this example but know it infintely moves the object in random
        --directions).
	else
        outputChatBox ( "must define object state as 'on' or 'off'" )
        --If player said something besides "on" or "off" for state, do nothing
 	end
end

See Also