isGM: Difference between revisions
Jump to navigation
Jump to search
(Player parameter not yet added) |
No edit summary |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 6: | Line 6: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
isGM() | isGM() | ||
</ | </syntaxhighlight > | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
isGM(player) | isGM(player) | ||
</ | </syntaxhighlight>'''Parameters''' | ||
{{param|player|player's name as a string to check if he is a GM or not.}} | {{param|player|player's name as a string to check if he is a GM or not.}} | ||
|examples= | |||
'''1. Test to see if current player is a GM.''' | |||
<syntaxhighlight lang="mtmacro" line> | |||
< | |||
I am a [r,if(isGM()): "GM"; "Player"] | I am a [r,if(isGM()): "GM"; "Player"] | ||
</ | </syntaxhighlight> | ||
< | |||
[ | '''2. Display a list of GMs.''' | ||
</ | |||
<syntaxhighlight lang="mtmacro"> | |||
[H: allPlayers = getAllPlayerNames("json")] | |||
[H: GMList = "[]"] | |||
[H: foreach(player,allPlayers), code: { | |||
[H, if(isGM(player)): GMList = json.append(GMList,player)] | |||
}] | |||
[R, if(! json.isEmpty(GMList)): "GM List: " + json.toList(GMList); "No players are listed as GM"] | |||
</syntaxhighlight> | |||
|changes= | |changes= | ||
* '''b91''' - Added {{code|player}} parameter}} | |||
[[Category:Permission Function]] | [[Category:Permission Function]] | ||
Latest revision as of 23:59, 13 March 2023
isGM() Function
• Introduced in version 1.3b48
Returns
true(1) if the player is a GM or false(0) if they are not.Usage
isGM()isGM(player)Parameters
player- player's name as a string to check if he is a GM or not.
Examples
1. Test to see if current player is a GM.
I am a [r,if(isGM()): "GM"; "Player"]
2. Display a list of GMs.
[H: allPlayers = getAllPlayerNames("json")]
[H: GMList = "[]"]
[H: foreach(player,allPlayers), code: {
[H, if(isGM(player)): GMList = json.append(GMList,player)]
}]
[R, if(! json.isEmpty(GMList)): "GM List: " + json.toList(GMList); "No players are listed as GM"]Version Changes
- b91 - Added
playerparameter