Pages

Advanced Functions (How-to-use)

Please note:

If you are not in version 1.3 or later of FallRoll, you will not have access to these functions. Please upgrade your plugin as soon as possible.

Configuration Options

Basic:

There are 4 basic configuration options which anyone should know how to use. In the case that you don't, I will explain them here. By default, this is what the lines should look like:

MetricsEnabled: true
RollPercentage: 25
RollDamagePercentNegated: 40
RollPreventsDeath: true

MetricsEnabled:

Created in version 1.0

  • The entire purpose of Metrics is to send anonymous server data to a website known as mcstats.org. You are free to toggle this feature on and off by using this function. You have two possible values, "true" and "false"

RollPercentage:

Created in version 1.0

  • This config value is to determine what the percent chance is to roll when holding shift off a cliff. For the default option, the player has a /40%/ chance to roll.
  • The available values for this are ranging from 0 (impossible to roll) to 100 (always roll). If anything higher than 100 is specified, it will just default to 100

RollDamagePercentNegated:

Created in version 1.1

  • The RollDamagePercentNegated value is to tell the current equation what percent of damage should be negated when a roll is successful. As default, when a player rolls, 40% of fall damage will not take effect to the player.
  • The available values for this are ranging from 0 (No fall damage is negated) to 100 (all damage is negated). If anything higher than 100 is specified, well, I'm actually not sure. The plugin will either 1. bug out, or 2. allow the player to GAIN health
  • For advanced usages (which will be covered under the Advanced section), this config option has another value. -1. Please read below for information on what this value will do

RollPreventsDeath:

Created in version 1.4

  • A very basic config option to define whether rolls are able to prevent death or not. Typically, when a player rolls and takes more than 20 damage, they will have a guaranteed survival at half a heart. By default, this value will be true
  • There are two possible values for this configuration option. "true" and "false"
    • true: When a player takes more than 20 damage on a roll, they will survive with half a heart
    • false: When a player takes more than 20 damage on a roll, they will die

Advanced

These options are for users that are very advanced with this plugin and feel they are ready to use their own mathematical equations. By default, these are the values you will see:

CustomFallDamageEquation: fallDamage - ((fallDamage / 100 ) * 40)
NumberHandling: default

CustomFallDamageEquation:

Created in version 1.3

  • This config option allows you to create your own mathematical equation to use for fall damage. By default, you will see the current equation used by the plugin.
  • In order for this function to be used you must have the "RollDamagePercentNegated" value set to 'null'. Exactly like that (will fix in the future so single quotations will not be needed)
  • As you'll notice, the default value has characters in there that are not integers, "fallDamage". That value represents the amount of fall damage the player takes when they hit the ground. That will allow your equation to be relative to the event that is occurring

NumberHandling:

Created in version 1.3

  • This value will determine how the final value for fall damage is managed. Health points are managed in whole numbers (1 = half a heart). However not all values result in whole numbers, and instead result in decimal values such as 5.3. This config value determines how that number should be dealt with
  • There are 3 possible values for this configuration option. "ceil" (or "up"), "floor" (or "down"), and "default"
    • ceil: The remaining value will be rounded upwards. Example: 5.3 will round to 6
    • floor: The remaining value will be rounded downwards. Example: 5.3 will round to 5
    • default: The remaining value will be rounded to its nearest whole integer. Example, 5.3 will round to 5, and 5.6 will round to 6

If you have any questions about configuration options and how to use them, please send me a private message, and I will assist you personally when I get the chance

Comments

Posts Quoted:
Reply
Clear All Quotes