Chat Commands: Difference between revisions
No edit summary |
No edit summary |
||
(11 intermediate revisions by 7 users not shown) | |||
Line 7: | Line 7: | ||
To use a chat command, you type directly into the chat window, using the following format: | To use a chat command, you type directly into the chat window, using the following format: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
/command argument | /command argument | ||
</ | </syntaxhighlight> | ||
where ''command'' is one of the commands in the table below, and ''argument'' is an appropriate argument (a dice roll, or a string of text, etc.) upon which the command acts. '''NOTE''': | where ''command'' is one of the commands in the table below, and ''argument'' is an appropriate argument (a dice roll, or a string of text, etc.) upon which the command acts. | ||
'''NOTE''': Remember, the commands shown below are always preceded by a forward slash ('''/''') character. | |||
'''NOTE''': Slash commands will only work correctly in a MapTool macro if they are the first text in the macro. This is a result of macros simply being text that is "stored up" until it's pushed into the chat window where it's executed. However, many chat commands have related macro functions that can achieve the same effect within only a part of a chat message. Those functions are pointed out below where applicable. | |||
==Built-in Commands== | ==Built-in Commands== | ||
Line 19: | Line 23: | ||
! style="background-color:#abcdef;" |Built-in Alias (if any) | ! style="background-color:#abcdef;" |Built-in Alias (if any) | ||
! style="background-color:#abcdef;" |Description | ! style="background-color:#abcdef;" |Description | ||
|- | |||
| about || a || Opens About window | |||
|- | |- | ||
| addtokenstate || tsa || Add a new token state that can be set on tokens | | addtokenstate || tsa || Add a new token state that can be set on tokens | ||
Line 34: | Line 40: | ||
| emote || me || Broadcast an emote to all connected players | | emote || me || Broadcast an emote to all connected players | ||
|- | |- | ||
| gm || togm || Send text to GM exclusively | | emotes || mes || Broadcast an emote to all connected players, adding the possessive (<b>'s</b>) to the end of the token name. | ||
|- | |||
| gm || togm || Send text to GM exclusively (see {{roll|g}}) | |||
|- | |- | ||
| goto || g || Go to location or go to token, e.g. ''/goto X,Y'' or ''/goto tokenname'' | | goto || g || Go to location or go to token, e.g. ''/goto X,Y'' or ''/goto tokenname'' (see {{func|goto}}) | ||
|- | |- | ||
| help || h || Display a list of available commands | | help || h || Display a list of available commands | ||
Line 44: | Line 52: | ||
| loadaliases || || Load a file that contains aliases, one per line, with a : between the name and the value (just as if you were typing it in) | | loadaliases || || Load a file that contains aliases, one per line, with a : between the name and the value (just as if you were typing it in) | ||
|- | |- | ||
| loadtokenstates || tsl || Load all of the token states | | loadtokenstates || tsl || Load all of the token states from a file | ||
|- | |- | ||
| ooc || || Out-of-character chat (chat is enclosed in double parentheses) | | ooc || || Out-of-character chat (chat is enclosed in double parentheses) | ||
Line 50: | Line 58: | ||
| reply || rep || Reply to the last player to whisper to you | | reply || rep || Reply to the last player to whisper to you | ||
|- | |- | ||
| roll || r || Roll dice (using a [[ | | roll || r || Roll dice (using a [[Dice Expressions]]) and broadcast result to all players (see {{func|roll}}) | ||
|- | |- | ||
| rollgm || rgm || Roll dice and broadcast result only to yourself and the GM | | rollgm || rgm || Roll dice and broadcast result only to yourself and the GM | ||
Line 64: | Line 72: | ||
| say || s || Broadcast a message to all connected players | | say || s || Broadcast a message to all connected players | ||
|- | |- | ||
| self || || Send a message only to yourself | | self || || Send a message only to yourself (see {{roll|s}}) | ||
|- | |||
| settokenproperty || stp || Set the value of a [[Token:token_property|Token Property]] (see {{func|setProperty}}) | |||
|- | |||
| settokenstate || sts || Set the value of a [[Token:state|Token State]] (see {{func|setState}}) | |||
|- | |- | ||
| | | table || tbl || Run a table lookup, e.g. ''/tbl tablename value-to-lookup'' (see {{func|table}}) | ||
|- | |- | ||
| | | texturenoise || tn || Turn Perlin noise on/off and get/set values. | ||
|- | |- | ||
| | | tmacro || tm || Run the given macro on the selected token (see {{roll|macro}}) | ||
|- | |- | ||
| | | tsay || ts || Say the given speech on the selected token (see {{func|getSpeech}}) | ||
|- | |- | ||
| | | version || v || Outputs MapTool version to chat. | ||
|- | |- | ||
| whisper || w || Send a message to a specific player | | whisper || w || Send a message to a specific player (see {{roll|w}}) | ||
|} | |} | ||
[[Category:MapTool]] | [[Category:MapTool]] | ||
{{Languages|Chat Commands}} | {{Languages|Chat Commands}} |
Latest revision as of 23:59, 13 May 2023
MapTool's chat system supports a number of "slash commands" (that is, commands preceded by a "/" character) that execute particular actions when typed directly into chat.
General Usage
To use a chat command, you type directly into the chat window, using the following format:
/command argument
where command is one of the commands in the table below, and argument is an appropriate argument (a dice roll, or a string of text, etc.) upon which the command acts.
NOTE: Remember, the commands shown below are always preceded by a forward slash (/) character.
NOTE: Slash commands will only work correctly in a MapTool macro if they are the first text in the macro. This is a result of macros simply being text that is "stored up" until it's pushed into the chat window where it's executed. However, many chat commands have related macro functions that can achieve the same effect within only a part of a chat message. Those functions are pointed out below where applicable.
Built-in Commands
Command | Built-in Alias (if any) | Description |
---|---|---|
about | a | Opens About window |
addtokenstate | tsa | Add a new token state that can be set on tokens |
alias | alias | Create a command alias |
clear | clr | Clear the chat window |
clearaliases | Clear all aliases | |
color | cc | Change your chat text color. Color must be in hexadecimal format, e.g. /cc #ff0099 |
emit | e | Broadcast text to all connected players without revealing who sent it (GM-only command) |
emote | me | Broadcast an emote to all connected players |
emotes | mes | Broadcast an emote to all connected players, adding the possessive ('s) to the end of the token name. |
gm | togm | Send text to GM exclusively (see [g:]) |
goto | g | Go to location or go to token, e.g. /goto X,Y or /goto tokenname (see goto()) |
help | h | Display a list of available commands |
impersonate | im | Speak as if you were someone or something else (typically, speak as if you were a token) |
loadaliases | Load a file that contains aliases, one per line, with a : between the name and the value (just as if you were typing it in) | |
loadtokenstates | tsl | Load all of the token states from a file |
ooc | Out-of-character chat (chat is enclosed in double parentheses) | |
reply | rep | Reply to the last player to whisper to you |
roll | r | Roll dice (using a Dice Expressions) and broadcast result to all players (see roll()) |
rollgm | rgm | Roll dice and broadcast result only to yourself and the GM |
rollme | rme | Roll dice and show the result only to yourself |
rollsecret | rsec | Roll dice and show the result only to the GM (hiding the result from even yourself) |
savealiases | Save all current aliases to a file | |
savetokenstates | tss | Save the current set of token states to a file |
say | s | Broadcast a message to all connected players |
self | Send a message only to yourself (see [s:]) | |
settokenproperty | stp | Set the value of a Token Property (see setProperty()) |
settokenstate | sts | Set the value of a Token State (see setState()) |
table | tbl | Run a table lookup, e.g. /tbl tablename value-to-lookup (see table()) |
texturenoise | tn | Turn Perlin noise on/off and get/set values. |
tmacro | tm | Run the given macro on the selected token (see [macro():]) |
tsay | ts | Say the given speech on the selected token (see getSpeech()) |
version | v | Outputs MapTool version to chat. |
whisper | w | Send a message to a specific player (see [w():]) |