StopObject - Revision history

SaintsTalles: /* Required Arguments */

2023-10-31T12:08:10Z

Required Arguments

← Older revision		Revision as of 12:08, 31 October 2023
Line 9:		Line 9:
	{{OOP\|\|[[object]]:stop\|\|}}		{{OOP\|\|[[object]]:stop\|\|}}
	===Required Arguments===		===Required Arguments===
	*'''~~theobject~~:''' the [[object]] whose movement you wish to stop		*'''theObject:''' the [[object]] whose movement you wish to stop

	===Returns===		===Returns===

SaintsTalles: /* Syntax */

2023-10-31T12:06:48Z

Syntax

← Older revision		Revision as of 12:06, 31 October 2023
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool stopObject ( object ~~theobject~~ )		bool stopObject ( object theObject )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[object]]:stop\|\|}}		{{OOP\|\|[[object]]:stop\|\|}}

Strix at 22:48, 4 October 2014

2014-10-04T22:48:54Z

← Older revision		Revision as of 22:48, 4 October 2014
Line 9:		Line 9:
	{{OOP\|\|[[object]]:stop\|\|}}		{{OOP\|\|[[object]]:stop\|\|}}
	===Required Arguments===		===Required Arguments===
	*'''theobject:''' ~~This is~~ the object whose movement you wish to stop		*'''theobject:''' the [[object]] whose movement you wish to stop

	===Returns===		===Returns===
	~~Returns~~ ''true'' if successful, ''false'' otherwise.		* ''true'' if successful.
			* ''false'' otherwise.

	==Example==		==Example==

MarioKart: OOP syntax added

2014-07-12T06:31:40Z

OOP syntax added

← Older revision		Revision as of 06:31, 12 July 2014
Line 7:		Line 7:
	bool stopObject ( object theobject )		bool stopObject ( object theobject )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[object]]:stop\|\|}}
	===Required Arguments===		===Required Arguments===
	*'''theobject:''' This is the object whose movement you wish to stop		*'''theobject:''' This is the object whose movement you wish to stop

Talidan at 15:40, 29 August 2007

2007-08-29T15:40:42Z

← Older revision		Revision as of 15:40, 29 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	~~<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->~~
	This will allow you to stop an object that is currently moving.		This will allow you to stop an object that is currently moving.

	==Syntax==		==Syntax==
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool stopObject ( object theobject )		bool stopObject ( object theobject )
Line 11:		Line 9:

	===Required Arguments===		===Required Arguments===
	~~<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->~~
	*'''theobject:''' This is the object whose movement you wish to stop		*'''theobject:''' This is the object whose movement you wish to stop

	===Returns===		===Returns===
	~~<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->~~
	Returns ''true'' if successful, ''false'' otherwise.		Returns ''true'' if successful, ''false'' otherwise.

	==Example==		==Example==
	~~<!-- Explain what the example is in a single sentance -->~~		This will allow you to toggle the random movement of a staircase object model using a ''randomObjectMovement'' function and stop it immediately with the stopObject command. This is achieved by using a "toggleobjectmove" command with a "on" or "off" parameter.
	This will allow you to toggle the random movement of a staircase object model and stop it immediately with the stopObject command.
	~~<!-- 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 ( thePlayer, commandName, state )		function objectMoveControl ( thePlayer, commandName, state )
Line 46:		Line 40:

	==See Also==		==See Also==
	~~<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->~~
	{{Object_functions}}		{{Object_functions}}

Arc at 18:52, 15 August 2007

2007-08-15T18:52:25Z

← Older revision		Revision as of 18:52, 15 August 2007
Line 24:		Line 24:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function objectMoveControl ( thePlayer, commandName, state )		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
	outputChatBox ( "Moving object randomly" )		outputChatBox ( "Moving object randomly" )

Arc at 18:52, 15 August 2007

2007-08-15T18:52:14Z

← Older revision		Revision as of 18:52, 15 August 2007
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 ( ~~player~~, commandName, state )		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		end
	addCommandHandler ( "toggleobjectmove", objectMoveControl )		addCommandHandler ( "toggleobjectmove", objectMoveControl )

Arc at 18:40, 15 August 2007

2007-08-15T18:40:48Z

← Older revision		Revision as of 18:40, 15 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Server client function}}
	<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->		<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
	This will allow you to stop an object that is currently moving.		This will allow you to stop an object that is currently moving.
Line 23:		Line 24:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function objectMoveControl ( player, commandName, state )		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'.		--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
	outputChatBox ( "Moving object randomly" )		outputChatBox ( "Moving object randomly" )
	mytimer = setTimer ( "randomObjectMovement", 2250, 0 )		mytimer = setTimer ( randomObjectMovement, 2250, 0 )
	--if player types "on" for the state ~~varible~~, turn on the timer, which triggers a ~~funciton~~ called randomObjectMovement that ~~asks~~ the object ~~to move~~ whenever it is called (not included for this example). The timer runs every 2 1/4 seconds for 0 times, which means it runs ~~infintely~~.		-- if the player types "on" for the state variable, turn on the timer, which triggers a function
	elseif state == "off" then		-- called randomObjectMovement that moves the object whenever it is called (not included for
	outputChatBox ( "Stopping object movement" )		-- this example). The timer runs every 2 1/4 seconds for 0 times, which means it runs infinitely.
	killTimer ( mytimer )		elseif state == "off" then
	stopObject ( myobject )		outputChatBox ( "Stopping object movement" )
	--If player typed "off" for state, stop the object movement immediately and kill the randomObjectMovement timer~~, which triggers the randomObjectMovement function.~~		killTimer ( mytimer )
	else		stopObject ( myobject )
	outputChatBox ( "must define object state as 'on' or 'off'" )		-- if the player typed "off" for state, stop the object movement immediately and kill the
	--If player ~~said~~ something besides "on" or "off" for state, do nothing		-- randomObjectMovement timer
	end		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		end
	addCommandHandler ( "toggleobjectmove", objectMoveControl )		addCommandHandler ( "toggleobjectmove", objectMoveControl )

Talidan: Updated command handler

2007-07-08T16:05:43Z

Updated command handler

← Older revision		Revision as of 16:05, 8 July 2007
Line 22:		Line 22:
	<!-- 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">
	~~addCommandHandler ( "toggleobjectmove", "objectMoveControl" )~~
	function objectMoveControl ( player, commandName, state )		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'.		--On "toggleobjectmove" in console, activate this command, which also asks the player to define the value for the varible 'state'.
Line 39:		Line 38:
	end		end
	end		end
			addCommandHandler ( "toggleobjectmove", objectMoveControl )
	</syntaxhighlight>		</syntaxhighlight>

Talidan: Ransom's correction was fine

2007-07-08T16:04:24Z

Ransom's correction was fine

← Older revision		Revision as of 16:04, 8 July 2007
Line 1:		Line 1:
	{{Needs_Checking\|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? --[[User:Ransom\|Ransom]] 20:54, 11 April 2007 (CDT)}}

	__NOTOC__		__NOTOC__
	<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->		<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->