ResetMapInfo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Server function}}
{{Server function}}
__NOTOC__
__NOTOC__
{{Needs_Checking|This also needs to reset the following:
*cursor state - needs checking
*player stats - needs checking
}}
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.
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.



Revision as of 14:49, 28 May 2009

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

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 page does not have an example.

addEventHandler("onResourceStart", getResourceRootElement(getThisResource()),
	-- Resource load event
	function()
            resetMapInfo()
        end
)

See Also