DtlTraders/Commands: Difference between revisions

From Citizens Wiki
No edit summary
 
(29 intermediate revisions by 2 users not shown)
Line 4: Line 4:
'''()''' - Optional <br /><br />
'''()''' - Optional <br /><br />


'''Command''' - command's syntax <br />
'''Command''' - command name <br />
'''Args Description''' - description of the command's arguments <br />
'''Args''' - arguments that must or may be parsed <br />
'''Require Selected''' - whether the command requires an trader or banker to be selected <br />
'''Mode''' - whether the command requires to be in a certain mode <br />
'''Require Ownership''' - whether the commands requires you to be the owner of the trader <br />
'''Required Mode''' - whether the command requires to be in a certain mode <br />
'''Permission''' - command's permission node <br />
'''Description''' - short description of the command <br />
'''Description''' - short description of the command <br />




== Trader Commands (1.9.4+) ==
== Commands ==  


{| class="wikitable" style="text-align: center; width: 100%"
<div style="width:100%;vertical-align:top">
|-
<div style="display:table;width:100%">
! style="width: 100%; background-color:#ADD8E6" colspan="7" | '''Trader commands'''
<div style="display:table-cell;width:160px;border-right:solid 1px black"><p style="margin:0px;padding:2px 10px;"><b>Command</b></p>
|-
</div>
! style="width: 200px;" | Command !! style="width: 400px;" | Args Description !! style="width: 50px;" | Require Selected !! style="width: 50px;" | Require Ownership !! style="width: 100px;" | Required mode !! style="width: 200px;" | Permission !! Description
<div style="display:table-cell;width:210px;border-right:solid 1px"><p style="margin:0px;padding:2px 10px;"><b>Args</b></p>
|-
</div>
| /trader<br/ /><b>Alias:</b> /dtrader || None || No || No || None || Updating || Shows up the current version and if a trader is selected the basic trader information
<div style="display:table-cell;width:160px;border-right:solid 1px black"><p style="margin:0px;padding:2px 10px;"><b>Mode</b></p>
|-
</div>
| /trader create || (t:trader) - trader type<br />(w:wallet) - wallet<br />(o:owner) - owner<br />(e:entity) - entity<br />(town:town) - ''Towny'' town tag<br />(sc:clan) - ''Simple-Clans'' clan tag<br />(f:faction) - ''Factions'' faction tag || No || No || None || dtl.trader.commands || Creates a new "Trader" NPC with the given name, type, wallet, entity-type, owner and specific ''"faction"'' accounts. Default wallet and type depends on permissions a player got.
<div style="display:table-cell;width:380px;"><p style="margin:0px;padding:2px 10px;"><b>Description</b></p>
|-
</div>
| /trader clear  || (stock) - stock to clear || Yes || Yes || Manager || dtl.trader.commands.clear || Clears the selected traders ''sell'' and ''buy'' stock, until a specific stock is supplied.
</div>
|-
| /trader help  || None || Yes || Yes || Manager || dtl.trader.commands.help || Shows the available command list ''(the appearing list will be changed till 2.0)''
|-
| /trader list || [stock] - the given stock to display (buy/sell) <br /> (page) - page number || Yes || Yes || Manager || dtl.trader.commands.list<br />dtl.trader.options.<stock> || Lists items the trader is selling ''(formating available in the locale file)''
|-
| /trader type  || (type) - trader type || Yes || Yes || Manager || dtl.trader.commands.type<br />dtl.trader.types.<type> ''(when changing)'' || Shows up the current trader type (only for player or server traders), or changes the type by the supplied argument
|-
| /trader wallet  || (wallet) - wallet type<br /> (account_name) - used with the ''bank'', ''towny'', ''simple-clans'' and ''Factions'' wallet, account or ''"faction"'' name (needs to be the owner of the bank account) || Yes || Yes || Manager || dtl.trader.commands.wallet<br />dtl.trader.wallets.<wallet> ''(when changing)'' || Shows up the current wallet the trader is using, or changes the type by the supplied argument
|-
| /trader owner  || (owner) - player name || Yes || Yes || dtl.trader.commands.owner || dtl.trader.commands.owner || Shows up the current owner of the selected trader, or changes the owner by the supplied argument  ''(only for player or server traders)''
|-
| /trader pattern || (pattern) - pattern name || Yes || Yes || Manager || dtl.trader.commands.pattern (no pattern specific settings now) || Sets the pattern the trader will use
|-
| /trader removepattern  || None || Yes || Yes || Manager || dtl.trader.commands.removepattern || Removes any pattern currently assigned to the trader, all pattern items will disappear
|-
| /trader log  || (trader name) - traders name ''(allows whitespace characters)'' || No || Yes || Manager || dtl.trader.commands.log || Shows all transactions the trader has performed. Shows the ''Buyer/Seller'', the ''item'' he has bought/sold and the ''amount'. When no trader is selected it lists all transactions of each trader owned, when supplying a name only this traders log will be showed.
|-
| /trader clearlog  || (trader name) - traders name ''(allows whitespace characters)'' || No || Yes || Manager || dtl.trader.commands.clearlog || Clears the selected traders log. If not traders is selected it clears all traders logs until you specify a name.
|-
| /trader balance  || None || Yes || Yes || Manager || dtl.trader.commands.balance || Shows up the balance of the selected trader. <br /><b>Requires npc-wallet to use</b>  
|-
| /trader deposit  || [amount] - the amount we want to deposit || Yes || Yes || Manager || dtl.trader.commands.deposit || Deposit given amount of money to traders wallet<br /><b>Requires npc-wallet to use</b>  
|-
| /trader withdraw  || [amount] - the amount we want to withdraw || Yes || Yes || Manager || dtl.trader.commands.withdraw || Withdraw given amount of money from traders wallet<br /><b>Requires npc-wallet to use</b>  
|}


== Banker Commands (planned) ==
<!-- /trader -->
Banker commands are not implemented at this time.
<div style="display:table;width:100%">
== Navigation ==
<div style="display:table-cell;width:160px;background-color: #F9F9F9;border-top:solid 1px"><!-- Cell -->
{| class="wikitable" style="text-align: center; width: 500px"
<p style="margin:0px;padding:2px 10px"><code style="margin:0px;display:block">/trader </code></p>
|-
</div>
! style="width: 100%; background-color:#ADD8E6" colspan="2" | '''DtlTraders'''
<div style="display:table-cell;width:210px;background-color: #F9F9F9;border-top:solid 1px"><!-- Cell -->
|-
<p style="margin:0px;padding:2px 10px"><code style="margin:0px;display:block">no arguments</code></p>
| Usage || | [http://wiki.citizensnpcs.com/DtlTraders/managing Managing] | [http://wiki.citizensnpcs.com/DtlTraders/trading Trading] | [http://wiki.citizensnpcs.com/DtlTraders/banking Banking] <!-- | [http://wiki.citizensnpcs.com/DtlTraders/patterns Patterns] -->
</div>
|-
<div style="display:table-cell;width:160px;background-color: #F9F9F9;border-top:solid 1px"><!-- Cell -->
| Configuration || | [http://wiki.citizensnpcs.com/DtlTraders/config Configuration] | [http://wiki.citizensnpcs.com/DtlTraders/Commands Commands] | [http://wiki.citizensnpcs.com/DtlTraders/permissions Permissions] | [http://wiki.citizensnpcs.com/DtlTraders/locale Locale]
<p style="margin:0px;padding:2px 10px"><code style="margin:0px;display:block;color:green">no mode required</code></p>
|-
</div>
| Types || | [http://wiki.citizensnpcs.com/DtlTraders/traders Traders] | [http://wiki.citizensnpcs.com/DtlTraders/bankers Bankers] <!--| [http://wiki.citizensnpcs.com/DtlTraders/auctionhouse Auction House] | [http://wiki.citizensnpcs.com/DtlTraders/wallets Wallets]-->
<div style="display:table-cell;width:380px;background-color: #F9F9F9;border-top:solid 1px"><!-- Cell -->
|}
<p style="margin:0px;padding:2px 10px"><code style="margin:0px;display:block">shows info about the current selected trader or just the plugin version</code></p>
</div>
</div>
 
 
</div>

Latest revision as of 01:41, 31 October 2013

DtlTraders strives to be as much user friendly as possible so there are only a few important commands to remember. Most tasks can be accomplished without their use.

[] - Mandatory
() - Optional

Command - command name
Args - arguments that must or may be parsed
Mode - whether the command requires to be in a certain mode
Description - short description of the command


Commands

Command

Args

Mode

Description

/trader

no arguments

no mode required

shows info about the current selected trader or just the plugin version