Chat Commands: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Info about related roll options new in 1.3.b58)
(Point out related macro functions)
Line 15: Line 15:
'''NOTE''':  Remember, the commands shown below are always preceded by a forward slash ('''/''') character.
'''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.  For version 1.3.b58 or later, see the {{roll|s}}, {{roll|w}}, and {{roll|g}} roll options for a method of sending only part of a message as if it were using the ''self'', ''whisper'', or ''gm'' chat commands respectively.
'''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 38: Line 38:
| 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
| 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 54: Line 54:
| 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 [[Chat:Dice | Dice Expression]]) and broadcast result to all players
| roll || r || Roll dice (using a [[Chat:Dice | Dice Expression]]) 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 68: Line 68:
| 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]]
| 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]]
| 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''
| table || tbl || Run a table lookup, e.g. ''/tbl tablename value-to-lookup'' (see {{func|table}})
|-
|-
| tmacro || tm || Run the given macro on the selected token
| tmacro || tm || Run the given macro on the selected token (see {{roll|macro}})
|-
|-
| tsay || ts || Say the given speech on the selected token
| tsay || ts || Say the given speech on the selected token (see {{func|getSpeech}})
|-
|-
| 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}}

Revision as of 02:28, 11 October 2009

Languages:  English  • Deutsch  • 日本語


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
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
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 to 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 Expression) 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())
tmacro tm Run the given macro on the selected token (see [macro():])
tsay ts Say the given speech on the selected token (see getSpeech())
whisper w Send a message to a specific player (see [w():])

Languages:  English  • Deutsch  • 日本語