ResetMapInfo: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Server function}} | {{Server function}} | ||
__NOTOC__ | |||
{{Needs_Checking|This also needs to reset the following: | |||
*gravity | *gravity | ||
*game speed | *game speed | ||
| Line 14: | Line 10: | ||
*nametag color | *nametag color | ||
*money | *money | ||
*weather | *weather}} | ||
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== | |||
<syntaxhighlight lang="lua"> | |||
bool resetMapInfo ( [player thePlayer = getRootElement()] ) | |||
</syntaxhighlight> | |||
===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. | |||
<syntaxhighlight lang="lua"> | |||
--add an example here | |||
</syntaxhighlight> | |||
==See Also== | |||
{{Map_functions}} | |||
Revision as of 16:39, 30 August 2007
|
This article needs checking. |
Reason(s): This also needs to reset the following:
|
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.
--add an example here
See Also