Commands: Difference between revisions

From Citizens Wiki

No edit summary
No edit summary
Line 19: Line 19:
! style="width: 100%; background-color:#ADD8E6" colspan="3" | '''Admin Commands'''
! style="width: 100%; background-color:#ADD8E6" colspan="3" | '''Admin Commands'''
|-
|-
! style="width: 250px;" | Command
! style="width: 250px;" | Command !! style="width: 170px;" | Permission !! Description
! style="width: 170px;" | Permission
! Description
|-
|-
| /citizens
| /citizens || citizens.admin || Show basic plugin information
| citizens.admin
| Show basic plugin information
|-
|-
| /citizens reload
| /citizens reload || citizens.admin || Reload Citizens
| citizens.admin
| Reload Citizens
|-
|-
| /citizens save
| /citizens save || citizens.admin || Save NPCs and configuration
| citizens.admin
| Save NPCs and configuration
|}
|}


Line 43: Line 35:
! style="width: 100%; background-color:#ADD8E6" colspan="6" | '''Help Commands'''
! style="width: 100%; background-color:#ADD8E6" colspan="6" | '''Help Commands'''
|-
|-
! style="width: 250px;" | Command
! style="width: 250px;" | Command !! style="width: 200px;" | Args Description !! style="width: 170px;" | Permission !! Description
! style="width: 200px;" | Args Description
! style="width: 170px;" | Permission
! Description
|-
|-
| /citizens help
| /citizens help || ''(Page)'' - Page number to display || citizens.help || Show Citizens help menu
| ''(Page)'' - Page number to display
| citizens.help
| Show Citizens help menu
|-
|-
| /npc help
| /npc help || ''(Page)'' - Page number to display || citizens.npc.help || Show NPC help menu
| ''(Page)'' - Page number to display
| citizens.npc.help
| Show NPC help menu
|}
|}


Line 66: Line 49:
! style="width: 100%; background-color:#ADD8E6" colspan="7" | '''NPC Commands'''
! style="width: 100%; background-color:#ADD8E6" colspan="7" | '''NPC Commands'''
|-
|-
! style="width: 200px;" | Command
! style="width: 200px;" | Command !! style="width: 200px;" | Args Description !! style="width: 150px;" | Require Selected !! style="width: 150px;" | Require Ownership !! style="width: 150px;" | Require Mob Type !! style="width: 170px;" | Permission !! Description
! style="width: 200px;" | Args Description
! style="width: 150px;" | Require Selected
! style="width: 150px;" | Require Ownership
! style="width: 150px;" | Require Mob Type
! style="width: 170px;" | Permission
! Description
|-
|-
| /npc
| /npc || ''None'' || Yes || Yes || No || None || Show basic NPC information
| ''None''
| Yes
| Yes
| No
| None
| Show basic NPC information
|-
|-
| /npc create
| /npc create || ''[name]'' - Name to give NPC <br>''(--type (type))'' - Mob type <br>''(--char (character))'' - Character || Yes || Yes || No || citizens.npc.create || Create a new NPC
| ''[name]'' - Name to give NPC <br>''(--type (type))'' - Mob type <br>''(--char (character))'' - Character
| Yes
| Yes
| No
| citizens.npc.create
| Create a new NPC
|-
|-
| /npc list
| /npc list || ''(-a)'' - List all NPCs <br>''(--owner (owner))'' - Owner <br>''(--type (type))'' - Mob type <br>''(--char (character))'' - Character || No || No || No || citizens.npc.list || List NPCs that match at least one of the given conditions
| ''(-a)'' - List all NPCs <br>''(--owner (owner))'' - Owner <br>''(--type (type))'' - Mob type <br>''(--char (character))'' - Character
| No
| No
| No
| citizens.npc.list
| List NPCs that match at least one of the given conditions
|-
|-
| /npc despawn
| /npc despawn || ''None'' || Yes || Yes || No || citizens.npc.despawn || Despawn an NPC
| ''None''
| Yes
| Yes
| No
| citizens.npc.despawn
| Despawn an NPC
|-
|-
| /npc remove
| /npc remove || ''(all)'' - Will remove all NPCs || Yes (Not if "all" is used) || Yes || No || citizens.npc.remove(.all) || Remove an NPC
| ''(all)'' - Will remove all NPCs
| Yes (Not if "all" is used)
| Yes
| No
| citizens.npc.remove(.all)
| Remove an NPC
|-
|-
| /npc rename
| /npc rename || ''[name]'' - New name for the NPC ||| Yes || Yes || No || citizens.npc.rename || Rename an NPC
| ''[name]'' - New name for the NPC
| Yes
| Yes
| No
| citizens.npc.rename
| Rename an NPC
|-
|-
| /npc select
| /npc select || ''[id]'' - ID of the NPC to select || No || Yes || No || citizens.npc.select || Selects an NPC with the given ID
| ''[id]'' - ID of the NPC to select
| No
| Yes
| No
| citizens.npc.select
| Selects an NPC with the given ID
|-
|-
| /npc character
| /npc character || ''[character]'' - Character to use || Yes || Yes || No || citizens.npc.character.* or citizens.npc.character.<character-name> for per-character permissions || Sets the [[Characters|character]] of an NPC
| ''[character]'' - Character to use
| Yes
| Yes
| No
| citizens.npc.character.* or citizens.npc.character.<character-name> for per-character permissions
| Sets the [[Characters|character]] of an NPC
|-
|-
| /npc owner
| /npc owner || ''[name]'' - Name of the new owner || Yes || Yes || No || citizens.npc.owner || Sets the owner of an NPC
| ''[name]'' - Name of the new owner
| Yes
| Yes
| No
| citizens.npc.owner
| Sets the owner of an NPC
|-
|-
| /npc spawn
| /npc spawn || ''[id]'' - ID of the NPC you want to spawn || Yes || Yes || No || citizens.npc.spawn || Spawn an existing NPC
| ''[id]'' - ID of the NPC you want to spawn
| Yes
| Yes
| No
| citizens.npc.spawn
| Spawn an existing NPC
|-
|-
| /npc tphere
| /npc tphere || ''None'' || Yes || Yes || No || citizens.npc.tphere || Teleport an NPC to your location
| ''None''
| Yes
| Yes
| No
| citizens.npc.tphere
| Teleport an NPC to your location
|-
|-
| /npc tp
| /npc tp || ''None'' || Yes || Yes || No || citizens.npc.tp || Teleport to an NPC
| ''None''
| Yes
| Yes
| No
| citizens.npc.tp
| Teleport to an NPC
|-
|-
| /npc lookclose
| /npc lookclose || ''None'' || Yes || Yes || No || citizens.npc.lookclose || Toggle an NPC's look-close state
| ''None''
| Yes
| Yes
| No
| citizens.npc.lookclose
| Toggle an NPC's look-close state
|-
|-
| /npc equip
| /npc equip || ''None'' || Yes || Yes || Yes - PLAYER || citizens.npc.edit.equip || Toggle equipment editor
| ''None''
| Yes
| Yes
| Yes - PLAYER
| citizens.npc.edit.equip
| Toggle equipment editor
|-
|-
| /npc path
| /npc path || ''None'' || Yes || Yes || No || citizens.npc.edit.path || Toggle path editor
| ''None''
| Yes
| Yes
| No
| citizens.npc.edit.path
| Toggle path editor
|-
|-
| /npc text
| /npc text || ''None'' || Yes || Yes || No || citizens.npc.edit.text || Toggle text editor
| ''None''
| Yes
| Yes
| No
| citizens.npc.edit.text
| Toggle text editor
|}
|}



Revision as of 15:54, 10 March 2012

Read below for detailed command documentation. For more info on per-type commands and permissions, see its corresponding page.

[] - Mandatory
() - Optional

Command - command's syntax
Args Description - description of the command's arguments
Require Selected - whether the command requires an NPC to be selected
Require Ownership - whether the commands requires you to be the owner of the NPC
Require Mob Type - whether the command requires an NPC to be a certain mob type
Permission - command's permission node
Description - short description of the command

Admin Commands

Commands used for administration of Citizens.

Help Commands

Commands used in-game to show the help screen.

NPC Commands

General commands used for all NPCs.

See Also

Characters
Text Syntax
Waypoints