Commands: Difference between revisions

From PSwiki
Jump to navigation Jump to search
Ethryn (talk | contribs)
alter formatting
Ethryn (talk | contribs)
add more commands
Line 2: Line 2:


If you find the 'syntax' column difficult to understand, see the [[#Syntax Guide|Syntax Guide]] below.
If you find the 'syntax' column difficult to understand, see the [[#Syntax Guide|Syntax Guide]] below.


==Character Commands==
==Character Commands==
Line 9: Line 10:
  ! Syntax
  ! Syntax
  ! Function
  ! Function
  |-
  |-
  ! /target
  ! /target
  | align="center" |
  | align="center" |
  /target [next] [pc<nowiki>|</nowiki>npc<nowiki>|</nowiki>item] [''name'']
  /target {[next<nowiki>|</nowiki>prev]} {[pc<nowiki>|</nowiki>npc<nowiki>|</nowiki>item]}} {''name''}
  | Targets on something or someone depending on the options
  | Targets on something or someone depending on the options
* '''next''' Targets the next thing or person
* '''next''' Targets the next thing or person
* '''prev''' Targets the prev thing or person
* '''pc''' Targets a player
* '''pc''' Targets a player
* '''npc''' Targets a non-player character
* '''npc''' Targets a non-player character
Line 21: Line 22:
* '''''name''''' Targets a thing or person containing ''"name"''
* '''''name''''' Targets a thing or person containing ''"name"''
* '''any''' Targets the nearest object
* '''any''' Targets the nearest object
  |-
  |-
  ! /trade
  ! /trade
Line 27: Line 27:
  /trade
  /trade
  | Start trading with the selected player.
  | Start trading with the selected player.
|}


==Communication==
{| width="100%" {{prettytable}}
|- bgcolor="#D2F9FB"
! Command
! Syntax
! Function
  |-
  |-
  ! /tellnpc
  ! /tellnpc
Line 33: Line 41:
  /tellnpc ''message''
  /tellnpc ''message''
  | ''This is the default command when entering sending a message in the NPC channel''
  | ''This is the default command when entering sending a message in the NPC channel''
Give a message to an [[Non-Player Character|NPC]]
Talk to a [[Non-Player Character|NPC]]
* '''''message''''' The message to deliver
* '''''message''''' The message to deliver
  |-
  |-
  ! /say
  ! /say
Line 41: Line 48:
  /say ''message''
  /say ''message''
  | ''This is the default command when entering sending a message in the main channel''
  | ''This is the default command when entering sending a message in the main channel''
Give a message to the players around you
Talk out loud
* '''''message''''' The message to deliver
|-
! /tell
| align="center" |
/tell ''player'' {[/me<nowiki>|</nowiki>/my]} ''message''
| Talk to someone privately. With this command you can send text only the person you specify can see.
* '''''player''''' The player in question
* '''''message''''' The message to deliver
* '''''message''''' The message to deliver
  |-
  |-
  ! /shout
  ! /shout
  | align="center" |
  | align="center" |
  /shout ''message''
  /shout ''message''
  | Yell a message all the players on the map
  | Yell a message at the top of your characters voice
* '''''message''''' The message to deliver
* '''''message''''' The message to deliver
|-
! /guild
| align="center" |
/guild {[/me<nowiki>|</nowiki>/my]} ''message''
| Speak to members of your guild, irrespective of distance
* '''''message''''' The message to deliver
* '''/me''' Similar to /me without /guild, but conveys it to guild members instead of to those in your immediate vicinity
* '''/my''' Similar to /my without /guild, but conveys it to guild members instead of to those in your immediate vicinity
|-
! /group
| align="center" |
/group {[/me<nowiki>|</nowiki>/my]} ''message''
| Speak to members of your group, irrespective of distance
* '''''message''''' The message to deliver
* '''/me''' Similar to /me without /group, but conveys it to group members instead of to those in your immediate vicinity
* '''/my''' Similar to /my without /group, but conveys it to group members instead of to those in your immediate vicinity
|-
! /away
| align="center" |
/away [off<nowiki>|</nowiki>''message'']
| Set an automatic response should someone /tell you. Set if you're going to be away from the keyboard for a while.
* '''''message''''' The message to deliver
* '''off''' deactivate the auto-response
  |}
  |}




==Player Commands==
==RolePlay Commands==


{| width="100%" {{prettytable}}
{| width="100%" {{prettytable}}
  |- style="text-align:center" bgcolor="#D2F9FB"
  |- bgcolor="#D2F9FB"
  ! Command
  ! Command
  ! Syntax
  ! Syntax
  ! Function
  ! Function
  |-
  |-
  ! /screenshot
  ! /greet
| align="center" |
/greet
| Greet the targeted person, or everyone if no one is target. Makes the character do the movement to greet (e.g. wave)
|-
! /wave
| align="center" |
/wave
| Makes the character wave
|-
! /bow
| align="center" |
/bow
| Makes the character bow down
|-
! /kneel
| align="center" |
/kneel
| Makes the character kneel in front of everybody
|-
! /sit
| align="center" |
/sit
| Makes the character sit on the ground
|-
! /me
| align="center" |
/me ''action''
| Gives a system message the your character those an action (no animation)
* '''''action''''' The action done by your character e.g. "juggle with four balls"
|-
! /my
| align="center" |
/my ''action''
| Similar to /me but speaking in the possessive (i.e. "Harnquest's hammer fell off the bench")
* '''''action''''' The action done by your character e.g. "juggle with four balls"
|-
! /marriage
| align="center" |
/marriage [propose ''player''<nowiki>|</nowiki>divorce] ''message''
| Propose marriage to or divorce another player
* '''propose''' propose marriage
* '''divorce''' divorce your partner
* '''''player''''' the player you're proposing to
* '''''message''''' relevant message
|-
! /auction
  | align="center" |
  | align="center" |
  /screenshot [nogui] [lossless]
  /auction ''description''
  | Takes a screenshot and saves it under "screenshots" in your install directory
  | Put an item up for sale or offer to buy something.
* '''nogui''' Takes a screenshot without all the user interface
* '''''description''''' brief description of the item
* '''lossless''' Takes a screenshot without loosing any data
|}
 


==Interface Commands==
{| width="100%" {{prettytable}}
|- bgcolor="#D2F9FB"
! Command
! Syntax
! Function
  |-
  |-
  ! /pos
  ! /buddylist
  | align="center" |
  | align="center" |
  /pos
  /buddylist
  | Gives you your current position in the world.
  | Shows your [[Buddy list]].
 
  |-
  |-
  ! /clear
  ! /ignore
  | align="center" |
  | align="center" |
  /clear
  /ignore
  | Clears all the data in all chat windows.
  | Shows your [[Ignore list]].
Conversation of anyone listed here will not appear in your chat window.
|}
 
 
==In-game Assistance==


{| width="100%" {{prettytable}}
|- style="text-align:center" bgcolor="#D2F9FB"
! Command
! Syntax
! Function
  |-
  |-
  ! /advisormode
  ! /advisormode
  | align="center" |
  | align="center" |
  /advisormode on<nowiki>|</nowiki>off
  /advisormode [on<nowiki>|</nowiki>off]
  | Used to toggle the advisor mode option
  | Used to toggle the advisor mode option
* '''on''' Toggle the advisor mode on
* '''on''' Toggle the advisor mode on
* '''off''' Toggle the advisor mode off
* '''off''' Toggle the advisor mode off
  |-
  |-
  ! /advice
  ! /advice
Line 96: Line 192:
* '''player''' The player's name goes in there
* '''player''' The player's name goes in there
* '''''message''''' The message to deliver.
* '''''message''''' The message to deliver.
  |-
  |-
  ! /help
  ! /help
Line 107: Line 202:




==RolePlay Commands==
==Utility Commands==
 
{| width="100%" {{prettytable}}
{| width="100%" {{prettytable}}
  |- bgcolor="#D2F9FB"
  |- bgcolor="#D2F9FB"
Line 115: Line 209:
  ! Function
  ! Function
  |-
  |-
  ! /greet
  ! /screenshot
| align="center" |
/screenshot {nogui} {lossless}
| Takes a screenshot and saves it under "screenshots" in your install directory
* '''nogui''' Takes a screenshot without all the user interface
* '''lossless''' Takes a screenshot in png format, rather than jpg
|-
! /pos
  | align="center" |
  | align="center" |
  /geet
  /pos
  | Greet the targeted person or everyone if no one is target. Makes the character do the movement to greet (e.g. wave)
  | Gives you your current position in the world.
 
  |-
  |-
  ! /wave
  ! /clear
  | align="center" |
  | align="center" |
  /wave
  /clear
  | Makes the character wave
  | Clears all the data in all chat windows.
 
  |-
  |-
  ! /bow
  ! /who
  | align="center" |
  | align="center" |
  /bow
  /who {''filter''}
  | Makes the character bow down
  | Lists players currently online whose name, guild or rank matches the filter. If no filter is specified, all players are listed.
 
* '''''filter''''' A Name, Rank or Guild
  |-
  |-
  ! /kneel
  ! /report
  | align="center" |
  | align="center" |
  /kneel
  /report ''player''
  | Makes the character kneel in front of everybody
  | Makes the server log everything the named player says for five minutes. Use this when a player is rude, cheating or griefing so the GMs and developers can review the log later and have proof.
* '''''player''''' the player in question
  |-
  |-
  ! /sit
  ! /add_ignore
  | align="center" |
  | align="center" |
  /sit
  /add_ignore ''player''
  | Makes the character sit on the ground
  | Add a player to your [[Ignore list]]. Use if a player is being rude and there is no GM around. Doing this will prevent anything they say from appearing in your chat window.
 
* '''''player''''' the player in question
  |-
  |-
  ! /me
  ! /remove_ignore
  | align="center" |
  | align="center" |
  /me ''action''
  /remove_ignore ''player''
  | Gives a system message the your character those an action (no animation)
  | Remove a player to your [[Ignore list]].
* '''''action''''' The action done by your character e.g. "juggle with four balls"
* '''''player''''' the player in question
  |}
  |}


Line 160: Line 260:
Any word after a '''command''' written in italics (i.e. "''example''") is a variable ''required'' '''parameter'''. You may use any word or phrase you like here.
Any word after a '''command''' written in italics (i.e. "''example''") is a variable ''required'' '''parameter'''. You may use any word or phrase you like here.


Any word after a '''command''' written between two Square brackets (i.e. "[example]" or "[''example'']") is an ''optional'' '''parameter'''. If it is also italicised, the '''parameter''' is ''variable''.
Any word after a '''command''' written between two curly brackets (i.e. "{example}" or "{''example''}") is an ''optional'' '''parameter'''. If it is also italicised, the '''parameter''' is ''variable''.


Any words separated with a 'pipe' (<nowiki>|</nowiki>) (ie. "apple | pear | peach") are choices. Only one of them may be chosen. For instance, "/example apple" is valid, whilst "/example apple peach" is not. Once again, if it is italicised the '''parameter''' is variable.
Any words separated with a 'pipe' (<nowiki>|</nowiki>) and surrounded by square brackets (ie. "[apple | pear | peach]") are choices. Only one of them may be chosen. For instance, "/example apple" is valid, whilst "/example apple peach" is not. Once again, if it is italicised the '''parameter''' is variable.


[[Category:Docs]]
[[Category:Docs]]

Revision as of 22:29, 18 July 2010

There are many different commands which can be used within PlaneShift. Some commands help roleplaying, there are called "Roleplay Commands", there are others that are only useful for the Player (Player Commands), and some are useful for the character (Character Commands).

If you find the 'syntax' column difficult to understand, see the Syntax Guide below.


Character Commands

Command Syntax Function
/target
/target {[next|prev]} {[pc|npc|item]}} {name}
Targets on something or someone depending on the options
  • next Targets the next thing or person
  • prev Targets the prev thing or person
  • pc Targets a player
  • npc Targets a non-player character
  • item Targets an item
  • name Targets a thing or person containing "name"
  • any Targets the nearest object
/trade
/trade
Start trading with the selected player.


Communication

Command Syntax Function
/tellnpc
/tellnpc message
This is the default command when entering sending a message in the NPC channel

Talk to a NPC

  • message The message to deliver
/say
/say message
This is the default command when entering sending a message in the main channel

Talk out loud

  • message The message to deliver
/tell
/tell player {[/me|/my]} message
Talk to someone privately. With this command you can send text only the person you specify can see.
  • player The player in question
  • message The message to deliver
/shout
/shout message
Yell a message at the top of your characters voice
  • message The message to deliver
/guild
/guild {[/me|/my]} message
Speak to members of your guild, irrespective of distance
  • message The message to deliver
  • /me Similar to /me without /guild, but conveys it to guild members instead of to those in your immediate vicinity
  • /my Similar to /my without /guild, but conveys it to guild members instead of to those in your immediate vicinity
/group
/group {[/me|/my]} message
Speak to members of your group, irrespective of distance
  • message The message to deliver
  • /me Similar to /me without /group, but conveys it to group members instead of to those in your immediate vicinity
  • /my Similar to /my without /group, but conveys it to group members instead of to those in your immediate vicinity
/away
/away [off|message]
Set an automatic response should someone /tell you. Set if you're going to be away from the keyboard for a while.
  • message The message to deliver
  • off deactivate the auto-response


RolePlay Commands

Command Syntax Function
/greet
/greet
Greet the targeted person, or everyone if no one is target. Makes the character do the movement to greet (e.g. wave)
/wave
/wave
Makes the character wave
/bow
/bow 
Makes the character bow down
/kneel
/kneel
Makes the character kneel in front of everybody
/sit
/sit
Makes the character sit on the ground
/me
/me action
Gives a system message the your character those an action (no animation)
  • action The action done by your character e.g. "juggle with four balls"
/my
/my action
Similar to /me but speaking in the possessive (i.e. "Harnquest's hammer fell off the bench")
  • action The action done by your character e.g. "juggle with four balls"
/marriage
/marriage [propose player|divorce] message
Propose marriage to or divorce another player
  • propose propose marriage
  • divorce divorce your partner
  • player the player you're proposing to
  • message relevant message
/auction
/auction description
Put an item up for sale or offer to buy something.
  • description brief description of the item


Interface Commands

Command Syntax Function
/buddylist
/buddylist
Shows your Buddy list.
/ignore
/ignore
Shows your Ignore list.

Conversation of anyone listed here will not appear in your chat window.


In-game Assistance

Command Syntax Function
/advisormode
/advisormode [on|off]
Used to toggle the advisor mode option
  • on Toggle the advisor mode on
  • off Toggle the advisor mode off
/advice
/advice player message
Give help to a player. This command is only available when the advisor mode is on, and you can only advise players who have asked for help
  • player The player's name goes in there
  • message The message to deliver.
/help
/help message
This is the default command when entering sending a message in the help channel

Give your message to the advisers.

  • message The message to deliver


Utility Commands

Command Syntax Function
/screenshot
/screenshot {nogui} {lossless}
Takes a screenshot and saves it under "screenshots" in your install directory
  • nogui Takes a screenshot without all the user interface
  • lossless Takes a screenshot in png format, rather than jpg
/pos
/pos
Gives you your current position in the world.
/clear
/clear
Clears all the data in all chat windows.
/who
/who {filter}
Lists players currently online whose name, guild or rank matches the filter. If no filter is specified, all players are listed.
  • filter A Name, Rank or Guild
/report
/report player
Makes the server log everything the named player says for five minutes. Use this when a player is rude, cheating or griefing so the GMs and developers can review the log later and have proof.
  • player the player in question
/add_ignore
/add_ignore player
Add a player to your Ignore list. Use if a player is being rude and there is no GM around. Doing this will prevent anything they say from appearing in your chat window.
  • player the player in question
/remove_ignore
/remove_ignore player
Remove a player to your Ignore list.
  • player the player in question

Syntax Guide

The following tables use a specific typographical convention. This typographical convention is not used in game. It is used here to clarify syntax.

A word preceded with a slash (i.e. "/example") is a command.

Any word after a command written in plain text (i.e. "example") is a set required parameter.

Any word after a command written in italics (i.e. "example") is a variable required parameter. You may use any word or phrase you like here.

Any word after a command written between two curly brackets (i.e. "{example}" or "{example}") is an optional parameter. If it is also italicised, the parameter is variable.

Any words separated with a 'pipe' (|) and surrounded by square brackets (ie. "[apple | pear | peach]") are choices. Only one of them may be chosen. For instance, "/example apple" is valid, whilst "/example apple peach" is not. Once again, if it is italicised the parameter is variable.