ResetMapInfo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
m (fix gender)
 
Line 1: Line 1:
{{Server function}}
{{Server function}}
__NOTOC__
__NOTOC__
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 their default state as if they had just joined the server, without any scripts affecting the player.


==Syntax==  
==Syntax==  

Latest revision as of 00:38, 6 January 2026

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

Syntax

bool resetMapInfo ( [ player thePlayer = root ] )

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.

function onResourceStop()
	resetMapInfo()
end
addEventHandler("onResourceStop", resourceRoot, onResourceStop)

See Also