StopObject: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 23: | Line 23: | ||
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized --> | <!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized --> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function objectMoveControl ( | function objectMoveControl ( thePlayer, commandName, state ) | ||
--On "toggleobjectmove" in console, activate this command, which also asks the player to define the value for the varible '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 | if state == "on" then | ||
| Line 40: | Line 40: | ||
outputChatBox ( "must define object state as 'on' or 'off'" ) | outputChatBox ( "must define object state as 'on' or 'off'" ) | ||
-- if the player typed something besides "on" or "off" for state, do nothing | -- if the player typed something besides "on" or "off" for state, do nothing | ||
end | |||
end | end | ||
addCommandHandler ( "toggleobjectmove", objectMoveControl ) | addCommandHandler ( "toggleobjectmove", objectMoveControl ) | ||
Revision as of 18:52, 15 August 2007
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.
function objectMoveControl ( thePlayer, 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 the player types "on" for the state variable, turn on the timer, which triggers a function
-- called randomObjectMovement that moves the object whenever it is called (not included for
-- this example). The timer runs every 2 1/4 seconds for 0 times, which means it runs infinitely.
elseif state == "off" then
outputChatBox ( "Stopping object movement" )
killTimer ( mytimer )
stopObject ( myobject )
-- if the player typed "off" for state, stop the object movement immediately and kill the
-- randomObjectMovement timer
else
outputChatBox ( "must define object state as 'on' or 'off'" )
-- if the player typed something besides "on" or "off" for state, do nothing
end
end
addCommandHandler ( "toggleobjectmove", objectMoveControl )
See Also