Commands: Difference between revisions
From Citizens Wiki
No edit summary |
|||
| Line 57: | Line 57: | ||
{| class="wikitable collapsible collapsed" style="text-align: center; width: 100%" | {| class="wikitable collapsible collapsed" style="text-align: center; width: 100%" | ||
|- | |- | ||
! style="width: 100%; background-color:#ADD8E6" colspan=" | ! style="width: 100%; background-color:#ADD8E6" colspan="7" | '''NPC Commands''' | ||
|- | |- | ||
! style="width: | ! style="width: 200px;" | Command | ||
! style="width: 200px;" | Args Description | ! style="width: 200px;" | Args Description | ||
! style="width: 150px;" | Require Selected | ! style="width: 150px;" | Require Selected | ||
! style="width: 150px;" | Require Ownership | ! style="width: 150px;" | Require Ownership | ||
! style="width: 150px;" | Require Mob Type | |||
! style="width: 170px;" | Permission | ! style="width: 170px;" | Permission | ||
! Description | ! Description | ||
| Line 68: | Line 69: | ||
| /npc | | /npc | ||
| ''None'' | | ''None'' | ||
| | | Yes | ||
| | | Yes | ||
| No | |||
| citizens.npc.info | | citizens.npc.info | ||
| Show basic NPC information | | Show basic NPC information | ||
| Line 75: | Line 77: | ||
| /npc create | | /npc create | ||
| [name] (--type (type) --char (character) --temp (template)) | | [name] (--type (type) --char (character) --temp (template)) | ||
| | | Yes | ||
| | | Yes | ||
| No | |||
| citizens.npc.create | | citizens.npc.create | ||
| Create a new NPC | | Create a new NPC | ||
| Line 82: | Line 85: | ||
| /npc despawn | | /npc despawn | ||
| ''None'' | | ''None'' | ||
| | | Yes | ||
| | | Yes | ||
| No | |||
| citizens.npc.despawn | | citizens.npc.despawn | ||
| Despawn an NPC | | Despawn an NPC | ||
| Line 89: | Line 93: | ||
| /npc remove | | /npc remove | ||
| ''(all)'' - Will remove all NPCs | | ''(all)'' - Will remove all NPCs | ||
| | | Yes (Not if "all" is used) | ||
| | | Yes | ||
| No | |||
| citizens.npc.remove(.all) | | citizens.npc.remove(.all) | ||
| Remove an NPC | | Remove an NPC | ||
| Line 96: | Line 101: | ||
| /npc rename | | /npc rename | ||
| ''[name]'' - New name for the NPC | | ''[name]'' - New name for the NPC | ||
| | | Yes | ||
| | | Yes | ||
| No | |||
| citizens.npc.rename | | citizens.npc.rename | ||
| Rename an NPC | | Rename an NPC | ||
| Line 103: | Line 109: | ||
| /npc select | | /npc select | ||
| ''[id]'' - ID of the NPC to select | | ''[id]'' - ID of the NPC to select | ||
| | | No | ||
| | | Yes | ||
| No | |||
| citizens.npc.select | | citizens.npc.select | ||
| Selects an NPC with the given ID | | Selects an NPC with the given ID | ||
| Line 110: | Line 117: | ||
| /npc character | | /npc character | ||
| ''[character]'' - Character to use | | ''[character]'' - Character to use | ||
| | | Yes | ||
| | | Yes | ||
| No | |||
| citizens.npc.character.* or citizens.npc.character.<character-name> for per-character permissions | | citizens.npc.character.* or citizens.npc.character.<character-name> for per-character permissions | ||
| Sets the [[Characters|character]] of an NPC | | Sets the [[Characters|character]] of an NPC | ||
| Line 117: | Line 125: | ||
| /npc owner | | /npc owner | ||
| ''[name]'' - Name of the new owner | | ''[name]'' - Name of the new owner | ||
| | | Yes | ||
| | | Yes | ||
| No | |||
| citizens.npc.owner | | citizens.npc.owner | ||
| Sets the owner of an NPC | | Sets the owner of an NPC | ||
| Line 124: | Line 133: | ||
| /npc spawn | | /npc spawn | ||
| ''[id]'' - ID of the NPC you want to spawn | | ''[id]'' - ID of the NPC you want to spawn | ||
| | | Yes | ||
| | | Yes | ||
| No | |||
| citizens.npc.spawn | | citizens.npc.spawn | ||
| Spawn an existing NPC | | Spawn an existing NPC | ||
| Line 131: | Line 141: | ||
| /npc tphere | | /npc tphere | ||
| ''None'' | | ''None'' | ||
| | | Yes | ||
| | | Yes | ||
| No | |||
| citizens.npc.tphere | | citizens.npc.tphere | ||
| Teleport an NPC to your location | | Teleport an NPC to your location | ||
| Line 138: | Line 149: | ||
| /npc tp | | /npc tp | ||
| ''None'' | | ''None'' | ||
| | | Yes | ||
| | | Yes | ||
| No | |||
| citizens.npc.tp | | citizens.npc.tp | ||
| Teleport to an NPC | | Teleport to an NPC | ||
| Line 145: | Line 157: | ||
| /npc lookclose | | /npc lookclose | ||
| ''None'' | | ''None'' | ||
| | | Yes | ||
| | | Yes | ||
| No | |||
| citizens.npc.lookclose | | citizens.npc.lookclose | ||
| Toggle an NPC's look-close state | | Toggle an NPC's look-close state | ||
Revision as of 08:39, 27 February 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 the plugin itself, along with debug commands.
| Admin Commands | ||
|---|---|---|
| Command | Permission | Description |
| /citizens | citizens.admin | Shows basic plugin information |
Help Commands
Commands used in-game to show the help screen.
| Help Commands | |||||
|---|---|---|---|---|---|
| Command | Args Description | Permission | Description | ||
| /citizens help | (Page) - Page number to display | citizens.help | Show Citizens help menu | ||
| /npc help | (Page) - Page number to display | citizens.npc.help | Show NPC help menu | ||
NPC Commands
General commands used for all NPCs.
| NPC Commands | ||||||
|---|---|---|---|---|---|---|
| Command | Args Description | Require Selected | Require Ownership | Require Mob Type | Permission | Description |
| /npc | None | Yes | Yes | No | citizens.npc.info | Show basic NPC information |
| /npc create | [name] (--type (type) --char (character) --temp (template)) | Yes | Yes | No | citizens.npc.create | Create a new NPC |
| /npc despawn | None | Yes | Yes | No | citizens.npc.despawn | Despawn an NPC |
| /npc remove | (all) - Will remove all NPCs | Yes (Not if "all" is used) | Yes | No | citizens.npc.remove(.all) | Remove an NPC |
| /npc rename | [name] - New name for the NPC | Yes | Yes | No | citizens.npc.rename | Rename an NPC |
| /npc select | [id] - ID of the NPC to select | No | Yes | No | citizens.npc.select | Selects an NPC with the given ID |
| /npc character | [character] - Character to use | Yes | Yes | No | citizens.npc.character.* or citizens.npc.character.<character-name> for per-character permissions | Sets the character of an NPC |
| /npc owner | [name] - Name of the new owner | Yes | Yes | No | citizens.npc.owner | Sets the owner of an NPC |
| /npc spawn | [id] - ID of the NPC you want to spawn | Yes | Yes | No | citizens.npc.spawn | Spawn an existing NPC |
| /npc tphere | None | Yes | Yes | No | citizens.npc.tphere | Teleport an NPC to your location |
| /npc tp | None | Yes | Yes | No | citizens.npc.tp | Teleport to an NPC |
| /npc lookclose | None | Yes | Yes | No | citizens.npc.lookclose | Toggle an NPC's look-close state |
Editor Commands
Commands for editing existing NPCs.
| Editor Commands | ||||||
|---|---|---|---|---|---|---|
| Command | Args Description | Require Selected | Require Ownership | Require Mob Type | Permission | Description |
| /npc equip | None | Yes | Yes | Yes - PLAYER | citizens.npc.edit.equip | Toggle equipment editor |
| /npc path | None | Yes | Yes | No | citizens.npc.edit.path | Toggle path editor |
| /npc text | None | Yes | Yes | No | citizens.npc.edit.text | Toggle text editor |
See Also
Characters
Text Syntax
Waypoints
| Quick Navigation | |
|---|---|
| Usage | Installation · Frequently Asked Questions · Commands · Editors · Characters · API · |
| Configuration | Configuration · Text Syntax · Permissions · Waypoints · Data Storage |