ResetMapInfo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
(2 intermediate revisions by 2 users not shown)
Line 9: Line 9:


===Optional Arguments===
===Optional Arguments===
'''thePlayer:''' The specific player you wish to restore the state of.  Not specifying this will result in all players map info being reset.
{{OptionalArg}}
*'''thePlayer:''' The specific player you wish to restore the state of.  Not specifying this will result in all players map info being reset.


==Returns==
==Returns==
Line 15: Line 16:


==Example==
==Example==
This page does not have an example.
This will reset all map info when the resource is stopped.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler("onResourceStart", getResourceRootElement(getThisResource()),
addEventHandler("onResourceStop", getResourceRootElement(getThisResource()),
-- Resource load event
-- Resource stop event
function()
function()
             resetMapInfo()
             resetMapInfo()
Line 27: Line 28:
==See Also==
==See Also==
{{Map_functions}}
{{Map_functions}}
[[Category:Needs_Example]]

Revision as of 12:02, 25 February 2013

This function is used to reset the state of a player. It is intended to restore a player to his default state as if he had just joined the server, without any scripts affecting him.

Syntax

bool resetMapInfo ( [player thePlayer = getRootElement()] )

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • thePlayer: The specific player you wish to restore the state of. Not specifying this will result in all players map info being reset.

Returns

Returns true if the map info was reset successfully, otherwise false.

Example

This will reset all map info when the resource is stopped.

addEventHandler("onResourceStop", getResourceRootElement(getThisResource()),
	-- Resource stop event
	function()
            resetMapInfo()
        end
)

See Also