[FTD] EZMode Library Documentation

EZMode Library Documentation

Video tutorials coming shortly.


||=====================||
||    Things To Know   ||
||=====================||


True and False
	for boolean values, "true" and "false" can be represented by a 1 for true and a 0 for false.
	any positive number above 0 will be seen as true.

Default values
	if no value is specified by the user the value will be left default.

Negative values
	the FTD variable editor has no support for negative values. As such, values that should be
	negative will have a specified equation (example: base value - 1000)

Floating point values
	the FTD variable editor has no support for decimal places. As such, values that should be
	floating point values will have a specified equation (example: base value / 100)

Set Values
	Some variables can have set values. They will be specified as a name(value) pair,
	example: PositiveInfinity(0) if only one value is specified, then other custom values
	are valid. If more than one set value is specified you can only choose from that list.

"doesScaleWithSize" flag
	Note that when doesScaleWithSize is true (1),
	scaled value = base value * volume of blocks. (not buoyancy)
	Simply put; the bigger the object the higher the values.
	If a variable doesn't say "can scale", then it can't.

"doesShowStrings" flag
	When defaulted or set to true (1), the ingame object will display the name and description
	fields when highlighted. It will NOT display the inventory override name. If this
	flag is set to false, the name and description will not be displayed. The object will
	still display data information regardless of this flag (such as battery charge/capacity)

||=====================||
|| CLASS DOCUMENTATION ||
||=====================||

class: ezRTG
	User Defined Variables
	|──doesShowStrings      (default true)
	|──doesScaleWithSize    (default false)
	|──doesProduceHeat      (default false)
	| \ if doesProduceHeat is true
	|  └──outputHeat        (default 10,  will scale)
	└──outputEnergy         (default 25,  will scale)

class: ezBattery
	User Defined Variables
	|──doesShowStrings      (default true)
	|──doesScaleWithSize    (default false)
	|──maximumCapacity      (default 1000, will scale)
	└──startingEnergy       (default 0,    will scale)

class: ezFuelTank
	User Defined Variables
	|──doesShowStrings      (default true)
	|──doesScaleWithSize    (default false)
	|──maximumCapacity      (default 1000,            will scale)
	└──startingFuel         (default maximumCapacity, will scale)

class: ezLaser
	User Defined Variables
	|──doesShowStrings      (default true)
	|──doesScaleWithSize    (default false)
	|──ammoUse              (default 10,   will scale)
	|──damagePerSecond      (default 1600, will scale)
	|──ReloadTime           (default 0,    will scale)
	|──Speed                (default 0)
	└──RequiredAccuracy     (default 0)

class: ezIonThruster
	User Defined Variables
	|──doesShowStrings      (default true)
	|──doesScaleWithSize    (default false)
	|──powerPerTick         (default 10,   will scale)
	|──maxThrust            (default 150,  will scale)
	|──topSpeed             (default 150,  set values = PositiveInfinity(0) )
	|──spaceRequired        (default 10)
	└──ionSize              (default 50,   value / 100)

class: ezJet
    User Defined Variables
	|──doesShowStrings      (default true)
	|──doesScaleWithSize    (default false)
	|──maxHeatOutput        (default 10)
	|──coolingFraction      (default 50,   value / 100)
	|──powerPerTick         (default 20,   will scale)
	|──maxThrust            (default 500,  will scale)
	|──topSpeed             (default 150,  set values = PositiveInfinity(0) )
	|──spaceRequired        (default 10)
	|──collideRadius        (default 80,   value / 100)
	└──suspenDistance       (default 50,   value / 100)

class: ezWheel
    User Defined Variables
	|──doesShowStrings      (default true)
	|──doesScaleWithSize    (default false)
	|──minMotorTorque       (default 990,  value-1000)
	|──maxMotorTorque       (default 10)
	|──minSteerAngle        (default 130,  value-180)
	|──maxSteerAngle        (default 50)
	|──spring               (default 5)
	|──damper               (default 2)
	|──collideRadius        (default 80,   value / 100)
	|──suspenDistance       (default 50,   value / 100)
	|──maxThrust            (default 500,  will scale)
	└──powerPerTick         (default 20,   will scale)

class: ezDetectorForward
    User Defined Variables
	|──doesShowStrings      (default true)
	|──horizontalFOV        (default 90)
	|──verticalFOV          (default 90)
	|──processingRequired   (default 10,   value / 10)
	|──bearingError         (default 100,  value / 100)
	|──probabilityFactor    (default 100,  value / 100)
	|──rangeErrorFraction   (default 3,    value / 1000)
	|──basicDetectionPeriod (default 66,   value / 1000)
	└──sensorType           (default 0,
       └── set values = Active_Radar(0) Active_Sonar(1) Visual_Camera(2) IR_Camera(3) Rangefinder(4) )

class: ezDetectorSphere
    User Defined Variables
	|──doesShowStrings      (default true)
	|──horizontalFOV        (default 360)
	|──verticalFOV          (default 180)
	|──processingRequired   (default 15,   value / 10)
	|──bearingError         (default 200,  value / 100)
	|──probabilityFactor    (default 50,   value / 100)
	|──rangeErrorFraction   (default 4,    value / 1000)
	|──basicDetectionPeriod (default 100,  value / 1000)
	└──sensorType           (default 0,
	   └── set values = Active_Radar(0) Passive_Radar(1) Active_Sonar(2) Passive_Sonar(3) Visual_Camera(4) IR_Camera(5) )

class: ezAmmoProcessor
	User Defined Variables
	|──doesShowStrings      (default true)
	|──doesScaleWithSize    (default false)
	|──metalUsePerBatch     (default 2,    will scale)
	|──ammoCreatedPerBatch  (default 10,   will scale)
	|──powerUsed            (default 20,   will scale)
	└──batchsPerSecond      (default 50,   value / 100)

class: ezAmmoBarrel
	User Defined Variables
	|──doesShowStrings      (default true)
	|──doesScaleWithSize    (default false)
	|──maximumCapacity      (default 100,             will scale)
	└──startingAmmo         (default maximumCapacity, will scale)


||=====================||
||  FTD  DOCUMENTATION ||
||=====================||

class: Battery
	User Defined Variables
	└──Maximum              (default 0)

class: ResourceContainer
	User Defined Variables
	└──N                     (default 0, scales by volume?)

class: Aileron
	User Defined Variables
	└──ForcePerSpeed        (default 0.1,  size scaled)

class: Tailplane
	User Defined Variables
	└──ForcePerSpeed        (default 0.2,  size scaled)

class: Wing
	User Defined Variables
	|──Lift                 (default 0.05, size scaled)
	└──WaterModifier        (default 5)

class: LaserCavity
	User Defined Variables
	└──CavitySize           (default 1 , value * 200)

class: AdvCannonBarrel
	User Defined Variables
	|──AccuracyModifier     (default 0)
	|──SpeedModifier        (default 0)
	|──RecoilModifier       (default 0)
	|──CooldownModifier     (default 0)
	|──AzimuthTravelLow     (default 0)
	|──AzimuthTravelHigh    (default 0)
	|──ElevationPositiveTravelLow  (default 0)
	|──ElevationPositiveTravelHigh (default 0)
	|──ElevationNegativeTravelLow  (default 0)
	|──ElevationNegativeTravelHigh (default 0)
	└──IsMantlet            (default false)