Commands: Difference between revisions

From PSwiki
Jump to navigation Jump to search
Maanahr (talk | contribs)
m Spell-check.
Ethryn (talk | contribs)
alter formatting
Line 1: Line 1:
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).
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).


In the following table are a list of commands. Under the command header is, as you guessed, the command like "/target". The options are the different options which can be used when using this command. If there is a comma between two commands, this means that they cannot be used together e.g. "/target pc npc" won't work since you are asking to target a player character that is a non-player character. If there is a slash (/) between a set of commands, this is the order they have to be in. For example "/target pc next" will target a player character called which contains "next" in its name, whereas what you want is "/target next pc" which will target the next player character. If an option is in italic, this means that it has to be filled by the player. Please not as well that many commands and options are case sensitive, therefore "/target pc" will target a player character, however "/target Pc" won't.
If you find the 'syntax' column difficult to understand, see the [[#Syntax Guide|Syntax Guide]] below.


=Character Commands=
==Character Commands==
<!-- Please use the following format for the table:
{| width="100%" {{prettytable}}
|- bgcolor="#D2F9FB"
! Command
! Syntax
! Function


{| Width="100%" border="1"
|-
|- style="text-align:center" bgcolor="#D2F9FB"
! /target
! Command
| align="center" |
! Options
/target [next] [pc<nowiki>|</nowiki>npc<nowiki>|</nowiki>item] [''name'']
! Function
| Targets on something or someone depending on the options
|-
* '''next''' Targets the next thing or person
| '''/command'''
* '''pc''' Targets a player
| option1a, option1b / option2a, option2b
* '''npc''' Targets a non-player character
| Description of command function
* '''item''' Targets an item
*'''option1a''' Description of what option1a does
* '''''name''''' Targets a thing or person containing ''"name"''
*'''option1b''' Description of what option1b does
* '''any''' Targets the nearest object
*'''option2a''' Description of what option2a does
*'''option2b''' Description of what option2b does
|}
-->


{| width="100%" border="1"
|-
|- style="text-align:center" bgcolor="#D2F9FB"
! /trade
! Command
| align="center" |
! Options
/trade
! Function
| Start trading with the selected player.
|-
 
| '''/target'''
|-
| next / pc, npc, item / ''name''
! /tellnpc
| Targets on something or someone depending on the options
| align="center" |
*'''next''' Targets the next thing or person
/tellnpc ''message''
*'''pc''' Targets a player
| ''This is the default command when entering sending a message in the NPC channel''
*'''npc''' Targets a non-player character
*'''item''' Targets an item
*'''''name''''' Targets a thing or person containing ''"name"''
*'''any''' Targets the nearest object
|-
| '''/trade'''
|
| Start trading with the selected player.
|-
| '''/tellnpc'''
| ''message''
| ''This is the default command when entering sending a message in the NPC channel''
Give a message to an [[Non-Player Character|NPC]]
Give a message to an [[Non-Player Character|NPC]]
*'''''message''''' The message to deliver
* '''''message''''' The message to deliver
|-
 
| '''/say'''
|-
| ''message''
! /say
| ''This is the default command when entering sending a message in the main channel''
| align="center" |
/say ''message''
| ''This is the default command when entering sending a message in the main channel''
Give a message to the players around you
Give a message to the players around you
*'''''message''''' The message to deliver
* '''''message''''' The message to deliver
|-
 
| '''/shout'''
|-
| ''message''
! /shout
| Give a message all the players on the map
| align="center" |
*'''''message''''' The message to deliver
/shout ''message''
|}
| Yell a message all the players on the map
* '''''message''''' The message to deliver
|}
 
 
==Player Commands==
 
{| width="100%" {{prettytable}}
|- style="text-align:center" bgcolor="#D2F9FB"
! Command
! Syntax
! Function


=Player Commands=
|-
<!-- Please use the following format for the table:
! /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 without loosing any data


{| Width="100%" border="1"
|-
|- style="text-align:center" bgcolor="#D2F9FB"
! /pos
! Command
| align="center" |
! Options
/pos
! Function
| Gives you your current position in the world.
|-
| '''/command'''
| option1a, option1b / option2a, option2b
| Description of command function
*'''option1a''' Description of what option1a does
*'''option1b''' Description of what option1b does
*'''option2a''' Description of what option2a does
*'''option2b''' Description of what option2b does
|-
|}
-->


{| Width="100%" border="1"
|-
|- style="text-align:center" bgcolor="#D2F9FB"
! /clear
! Command
| align="center" |
! Options
/clear
! Function
| Clears all the data in all chat windows.
|-
 
| '''/screenshot'''
|-
| nogui / lossless
! /advisormode
| Takes a screenshot and saves it under "screenshots" in your install directory
| align="center" |
*'''nogui''' Takes a screenshot without all the user interface
/advisormode on<nowiki>|</nowiki>off
*'''lossless''' Takes a screenshot without loosing any data
| Used to toggle the advisor mode option
|-
* '''on''' Toggle the advisor mode on
| '''/pos'''
* '''off''' Toggle the advisor mode off
|
 
| Gives you your current position in the world.
|-
|-
! /advice
| '''/clear'''
| align="center" |
|
/advice ''player'' ''message''
| Clears all the data in all chat windows.
| 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
| '''/advisormode'''
* '''''message''''' The message to deliver.
| on, off
 
| Used to toggle the advisor mode option
|-
*'''on''' Toggle the advisor mode on
! /help
*'''off''' Toggle the advisor mode off
| align="center" |
|-
/help ''message''
| '''/advice'''
| ''This is the default command when entering sending a message in the help channel''
| ''player'' / ''message''
| Give help to the player. This command is only available when the advisor mode is on, and you can only advice players who have asked for help
*'''player''' The player's name goes in there
*'''''message''''' The message to deliver.
|-
| '''/help'''
| ''message''
| ''This is the default command when entering sending a message in the help channel''
Give your message to the advisers.
Give your message to the advisers.
*'''''message''''' The message to deliver
* '''''message''''' The message to deliver
|}
|}
 
 
==RolePlay Commands==
 
{| width="100%" {{prettytable}}
|- bgcolor="#D2F9FB"
! Command
! Syntax
! Function
|-
! /greet
| align="center" |
/geet
| 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"
|}
 
==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.'''


=RolePlay Commands=
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.
<!-- Please use the following format for the table:


{| Width="100%" border="1"
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''.
|- style="text-align:center" bgcolor="#D2F9FB"
! Command
! Options
! Function
|-
| '''/command'''
| option1a, option1b / option2a, option2b
| Description of command function
*'''option1a''' Description of what option1a does
*'''option1b''' Description of what option1b does
*'''option2a''' Description of what option2a does
*'''option2b''' Description of what option2b does
|}
-->


{| Width="100%" border="1"
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.
|- style="text-align:center" bgcolor="#D2F9FB"
! Command
! Options
! Function
|-
| '''/greet'''
|
| Greet the targeted person or everyone if no one is target. Makes the character do the movement to greet (e.g. wave)
|-
| '''/wave'''
|
| Makes the character wave
|-
| '''/bow'''
|
| Makes the character bow down
|-
| '''/kneel'''
|
| Makes the character kneel in front of everybody
|-
| '''/sit'''
|
| Makes the character sit on the ground
|-
| '''/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"
|}


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

Revision as of 21:22, 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] [pc|npc|item] [name]
Targets on something or someone depending on the options
  • next Targets the next 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.
/tellnpc
/tellnpc message
This is the default command when entering sending a message in the NPC channel

Give a message to an NPC

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

Give a message to the players around you

  • message The message to deliver
/shout
/shout message
Yell a message all the players on the map
  • message The message to deliver


Player 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 without loosing any data
/pos
/pos
Gives you your current position in the world.
/clear
/clear
Clears all the data in all chat windows.
/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


RolePlay Commands

Command Syntax Function
/greet
/geet
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"

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 Square 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' (|) (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.