View source for Auto Point Adjustments (APA)

[[Category:Admin]]
[[Category:DKP]]

= APA Types =

== Maximum Points (Repeating) ==
The repeating maximum points APA is run every x days. Therefore, the points of a char can be over the set limit until the next run.
* Upper limit - Set to "100" if you want that no points are over this value
* Lower limit - Set to "-100" if you want that no chars has lower points than -100
* Check point cap every x days - The interval. Set to 7 if you want to run this APA ever week
* Time of Execution - set to a time that you want to run this APA
* Start date - set the base date. The next calculation run is done on Start-Date plus Interval-Days
Please keep in mind that the value "0" does not disable the cap, but is seen as a value. Therefore set both limits to a value that fits to you.

== Maximum Points (Shown) ==
A shown cap means that the points will never be over (for the upper limit) or under (for the lower limit) limit. This will only apply for the visible point standings, internally the points can be more or less than the set cap.
* Upper limit - Set to "100" if you want that no points are over this value
* Lower limit - Set to "-100" if you want that no chars has lower points than -100
Please keep in mind that the value "0" does not disable the cap, but is seen as a value. Therefore set both limits to a value that fits to you.

== Maximum Points (Hard) ==
A hard cap means that the points will never be over (for the upper limit) or under (for the lower limit) limit. An adjustments will be created if the char is over/under the limit.
* Upper limit - Set to "100" if you want that no points are over this value
* Lower limit - Set to "-100" if you want that no chars has lower points than -100
Please keep in mind that the value "0" does not disable the cap, but is seen as a value. Therefore set both limits to a value that fits to you.

== Decay on current ==
This decay is done on the current points.
Example: 
* Before First run: 100 Points
* First decay (10%): 90 Points
* Char earns 20 Points: 90 + 20 = 110 Points
* Second decay (10%): 99 Points
* ...
With the option "Period, after the points become 0." you can select that old points will not be considered and that they are treated as 0 points.

== Decay on Raids,Items and Adjustments ==
You can decay Raids,Items and/or Adjustments, for example if you only want the decay adjustments.
The options and calculations are the same as for the current decay.

== Onetime Adjustment ==
As the name states, a calculation function will be executed only once.
Select MultiDKP and Event, as the Onetime Adjustment will be saved as an Adjustment for the characters.
Per default, only the total standings of the user are considered (mains), if you want to apply the onetime adjustment to all chars (Main+Twinks), hit the option.

== Start Points ==
Give starting points to your characters. All created characters after the start-date will get the named points. If you want that all characters will get the start points, select the appropriate option.

* Start date: Only chars created/first raid after this date will be considered 
* Give Startpoints also to Chars that have been created/had their first raid before the Startdate : all your chars will get the start points
* Event : The Event which should be used. Make sure that it is in the correct MultiDKP Pool.
* Value : Number of Startpoints
* Give Startpoints on Char-creation : chars will get the start points when they are created, otherwise the first raid date is used
* Give Startpoints also to Twinks : if "off", only the main will get the startpoints and no twink

= Calculation Functions =
== Examples ==
* 5% Decay 
<source lang="php">
points = value * 0.95
</source>
* 10% Decay
<source lang="php">
points = value * 0.90
</source>
* 20% Decay for everything over 100 points
<source lang="php">
var1 = value - 100
points = (var1 > 0) ? ((var1*0.8)+100) : value;
</source>
* 20% Decay for positive points (works only on current decay)
<source lang="php">
points = (value > 0) ? (value*0.8) : value;
</source>

== Variables ==
* value = current value of DKP
* date = creation date of Raid/Item/Adjustment
* ref_date = date of the current calculation