DtlTraders/patterns: Difference between revisions

Revision as of 22:13, 27 December 2012

Overview

Every pattern is saved in the patterns.yml file located in the plugin's main folder. (plugins/DtlCitizensTrader)
You can change the directory in the configuration file.

There are 3 types of patterns:

- Pricing patterns
Sets item prices and pricing tiers.

- Item patterns
Will add certain items to the trader's stock.

By using item patterns you can also set two items in the same slot and each can have a different function. An example of this can be found below.

- Market traders
A special pattern used by market traders. It has a different construction so care has to be taken to set it up properly.

Basics

An example of a basic pricing pattern:

default: prices: all: multiplier: 1.0 35: 1.5 '35:2': 2.0 sell: 1: 0.33 2: 0.66 3: 0.99 buy: multiplier: 0.9 1: 0.33 2: 0.66 3: 0.99

In the all section you can set item price for both buying and selling. To change the item's value depending on the transaction type you can use the sell and buy sections.

The multiplier is used to quickly change prices. By using this setting you can adjust prices on the server scale just by setting a single number. You could for example lower the value of any offered item by setting multiplier to 0.9 - every price would then be reduced by 10%. When no multiplier is set the value defaults to 1.0.

Multipliers set in the sell or buy sections have higher priority than those set in the all section. In the above example 0.9 set in the buy block overrides 1.0 set in the all section.

When dealing with blocks that use additional data value such as colored wool keep in mind that you can, for example, set the price of any wool by using 35: <price>. Changing that line to '35:0': <price> would only apply to white wool. Moreover if you set the general price for wool (35: <price1>) and then assign a different price to the white wool ('35:0': <price2>) then the more specific assignment has priority. In this case every wool block would cost <price1> with the exception of white wool which would be set to <price2>.

Tiers

Tiers allow you to define multiple patterns and apply them automatically depending on the user's permissions. Each tier can have a different multiplier and/or item prices.

For example creating two tiers - tier1 with multiplier set to 0.9, and tier2 with multiplier set to 0.8 will have the following effect:

[the author isn't sure what will happen. this bit will be updated soon]

Tiers are defined after the pattern and have exactly the same structure.

default: prices: all: multiplier: 1.0 35: 1.5 '35:2': 2.0 sell: 1: 0.33 2: 0.66 3: 0.99 buy: multiplier: 0.9 1: 0.33 2: 0.66 3: 0.99 tier1: all: multiplier: 0.9 sell: 2: 0.11 buy: multiplier: 1.1

[the author isn't sure what will happen. this bit will be updated soon]

Navigation

DtlTraders
Configuration	Commands \| Permissions
Usage
Types

@@ Line 1: / Line 1: @@
-What are those patterns, I bet many of you are just confused abut it how does it work, what does it add and how you can use it. You could hear some things when I talked about it, here I'm going to explain what does it add.
+== Overview ==
+Every pattern is saved in the ''patterns.yml'' file located in the plugin's main folder. (plugins/DtlCitizensTrader)<br /> You can change the directory in the configuration file.
+There are 3 types of patterns:
-== Overview ==
+- ''Pricing patterns''<br>
+Sets item prices and pricing tiers.
-All patterns basically should be saved in the ''patterns.yml'', in the main plugin folder. (plugins/DtlCitizensTrader)<br /> You may change the directory in the ''config.yml''.
+- ''Item patterns''<br>
+Will add certain items to the trader's stock.
+By using item patterns you can also set two items in the same slot and each can have a different function. An example of this can be found below.
-There are 3 types of patterns, even when each type is just a simple part of a whole pattern. We got ''Pricing patterns'', where you just set item prices and pricing tiers. Another pattern type is ''Items pattern'' so this pattern will add items to the traders stock, but here you can also set 2 items under the same slot which can be used in different ways, going to show one here. Third type is a special pattern construction used by ''Market traders'', so you need to set them properly.
+- ''Market traders''<br>
+A special pattern used by market traders. It has a different construction so care has to be taken to set it up properly.
 == Basics ==
-Here you got a example basic ''pricing pattern'':
+An example of a basic ''pricing pattern'':
 <div style="border: solid 1px black;padding:10px;padding-top:0px"><span style="white-space: pre;color:darkgreen;">
 default:
@@ Line 30: / Line 39: @@
 </span></div>
-This shows how to set a ''pricing pattern'', it isn't really hard to understand, the '''all''' section will set prices for both tabs, where '''sell''' sets prices for sell tab and '''buy''' for buy tab, the multiplier is used to fast change prices, like all prices on server where to high, so lets lesser them by 10% = 0.9, if no multiplier is set it's just 1.0 so you could remove that multiplier in the all section if set any multiplier in ''sell'' or ''buy'' overrides the ''all'' multiplier, so in this example 0.9 overrides 1.0 so sell got not 1.0 and buy got prices of 0.9 basic price.
+In the '''all''' section you can set item price for both buying and selling. To change the item's value depending on the transaction type you can use the '''sell''' and '''buy''' sections.<br>
+<br>
-Also if you got items with additional data like ''wool'', you can set the price for each wool by just using the id 35: <price>, but if you add '35:0': it will only apply to ''white wool'', if both are set the more specific version will override the general price for that id so 35: <price> will be overridden by '35:0': <another price> just for while wool, all other wool colors will have <price>.
+The multiplier is used to quickly change prices. By using this setting you can adjust prices on the server scale just by setting a single number. You could for example lower the value of any offered item by setting multiplier to 0.9 - every price would then be reduced by 10%. When no multiplier is set the value defaults to 1.0.<br>
+<br>
+Multipliers set in the ''sell'' or ''buy'' sections have higher priority than those set in the ''all'' section. In the above example '''0.9''' set in the '''buy''' block overrides '''1.0''' set in the '''all''' section.<br>
+<br>
+When dealing with blocks that use additional data value such as colored wool keep in mind that you can, for example, set the price of any wool by using 35: <price>. Changing that line to '35:0': <price> would only apply to ''white wool''. Moreover if you set the general price for wool '''(35: <price1>)''' and then assign a different price to the white wool '''('35:0': <price2>)''' then the more specific assignment has priority. In this case every wool block would cost <price1> with the exception of white wool which would be set to <price2>.
+== Tiers ==
-But how does tiering works?
+Tiers allow you to define multiple patterns and apply them automatically depending on the user's permissions. Each tier can have a different multiplier and/or item prices.
-A tier is like a pattern within a pattern, so tiers override the patterns prices, except multipliers, because those are calculated from the highest tier down to the general pattern.
+For example creating two tiers - ''tier1'' with multiplier set to 0.9, and ''tier2'' with multiplier set to 0.8 will have the following effect:
-so settings two tiers ''tier1'' with multipliers 0.9 and ''tier2'' with multiplier 0.8, will cause each Player with tier1 to have prices multiplied by 0.9*1.0 default multiplier for general pattern, but each player with both tiers will cause to have the price multiplied by 0.8*0.9*1.0, this allows to easily change prices for groups of VIPS, lets say we got VIP and VIP+ but we want both groups to lesser prices, so we just need to lesser them in ''tier1'' if VIP2 got both tiers.
+[the author isn't sure what will happen. this bit will be updated soon]
-where do we put tiers? A tiered pricing pattern looks like this
+Tiers are defined after the pattern and have exactly the same structure.
 <div style="border: solid 1px black;padding:10px;padding-top:0px"><span style="white-space: pre;color:darkgreen;">
 default:
@@ Line 67: / Line 81: @@
 </span></div>
-so with that pattern grass would be cost 0.11*0.9*1.0 for a player with the tier1 permission
+[the author isn't sure what will happen. this bit will be updated soon]
 <!--This page shows how to use the price patterns. Below is a sample pattern along with an explanation of how it works and what changes when using it together with manager mode.