Difference between revisions of "ObjectType:float"
Jump to navigation
Jump to search
(9 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
+ | {{ObjectType-Vitals|float|[[LavishScript]]|none|The string representation of this float, to the nearest hundredth|[[ObjectType:float|float]]|no|float}} | ||
== Description == | == Description == | ||
A float, named for its <tt>floating-point</tt>, represents a number with a [http://dictionary.reference.com/search?q=mantissa mantissa.] | A float, named for its <tt>floating-point</tt>, represents a number with a [http://dictionary.reference.com/search?q=mantissa mantissa.] | ||
+ | |||
== Members == | == Members == | ||
− | * string '''Deci''': The value of this float, to the nearest tenth | + | * [[ObjectType:string|string]] '''Deci''': The value of this float, to the nearest tenth |
− | * string '''Centi''': The value of this float, to the nearest hundredth | + | * [[ObjectType:string|string]] '''Centi''': The value of this float, to the nearest hundredth |
− | * string '''Milli''': The value of this float, to the nearest thousandth | + | * [[ObjectType:string|string]] '''Milli''': The value of this float, to the nearest thousandth |
− | * int '''Int''': The value of this float, to | + | * [[ObjectType:int|int]] '''Int''': The value of this float, to its largest whole number (e.g. for 1.9 this is 1, for -0.1, this is -1) |
− | * string '''Precision['''#''']''': The value of this float, to the nearest # decimal places (e.g. 1 is tenths, 2 is hundredths, 3 is thousandths, and so on) | + | * [[ObjectType:string|string]] '''Precision['''#''']''': The value of this float, to the nearest # decimal places (e.g. 1 is tenths, 2 is hundredths, 3 is thousandths, and so on) |
+ | * [[ObjectType:int|int]] '''Ceil''': The value of this float, to its largest partial number (e.g. for 1.1 this is 2, for -0.1 this is 0). | ||
+ | * [[ObjectType:int|int]] '''Round''': The value of this float, rounded to the nearest whole number | ||
+ | * [[ObjectType:bool|bool]] '''Between[a,b]''': TRUE if a<= value and value <= b | ||
+ | * [[ObjectType:bool|bool]] '''Equal['''[[LavishScript:Mathematical Formulae|formula]]''']''': TRUE if the float matches the specified value | ||
+ | * [[ObjectType:string|string]] '''AsJSON''': A string with the value of the float, as would be in JSON | ||
+ | |||
== Methods == | == Methods == | ||
* '''Inc''': Increments this float by 1.0 | * '''Inc''': Increments this float by 1.0 | ||
− | * '''Inc['''formula''']''': Increments this float by a given amount | + | * '''Inc['''[[LavishScript:Mathematical Formulae|formula]]''']''': Increments this float by a given amount |
* '''Dec''': Decrements this float by 1.0 | * '''Dec''': Decrements this float by 1.0 | ||
− | * '''Dec['''formula''']''': Decrements this float by a given amount | + | * '''Dec['''[[LavishScript:Mathematical Formulae|formula]]''']''': Decrements this float by a given amount |
− | * '''Set['''formula''']''': Sets this float to a given value | + | * '''Set['''[[LavishScript:Mathematical Formulae|formula]]''']''': Sets this float to a given value |
− | |||
− | |||
== Examples == | == Examples == | ||
+ | ===Declare a float variable=== | ||
+ | *Declare Faction float | ||
+ | ===Set a variable to a given number=== | ||
+ | *Faction:Set[3912.392] | ||
+ | ===Increment a float variable=== | ||
+ | *Faction:Inc | ||
+ | ===Decrement a float variable=== | ||
+ | *Faction:Dec | ||
+ | ===Add two floating variables=== | ||
+ | *bankcash1:Set[${bankcash1}+${bankcash2}] | ||
+ | *bankcash1:Inc[${bankcash2}] | ||
+ | :'''Note:''' These two commands are identical | ||
+ | |||
== See Also == | == See Also == | ||
− | + | {{LavishScript:ObjectType}} |
Latest revision as of 14:21, 14 October 2019
float | |
Defined By | LavishScript |
Inherits | none |
Reduces To | The string representation of this float, to the nearest hundredth |
Variable Object Type | float |
Uses Sub-Types | no |
C/C++ Type | float |
Contents
Description
A float, named for its floating-point, represents a number with a mantissa.
Members
- string Deci: The value of this float, to the nearest tenth
- string Centi: The value of this float, to the nearest hundredth
- string Milli: The value of this float, to the nearest thousandth
- int Int: The value of this float, to its largest whole number (e.g. for 1.9 this is 1, for -0.1, this is -1)
- string Precision[#]: The value of this float, to the nearest # decimal places (e.g. 1 is tenths, 2 is hundredths, 3 is thousandths, and so on)
- int Ceil: The value of this float, to its largest partial number (e.g. for 1.1 this is 2, for -0.1 this is 0).
- int Round: The value of this float, rounded to the nearest whole number
- bool Between[a,b]: TRUE if a<= value and value <= b
- bool Equal[formula]: TRUE if the float matches the specified value
- string AsJSON: A string with the value of the float, as would be in JSON
Methods
- Inc: Increments this float by 1.0
- Inc[formula]: Increments this float by a given amount
- Dec: Decrements this float by 1.0
- Dec[formula]: Decrements this float by a given amount
- Set[formula]: Sets this float to a given value
Examples
Declare a float variable
- Declare Faction float
Set a variable to a given number
- Faction:Set[3912.392]
Increment a float variable
- Faction:Inc
Decrement a float variable
- Faction:Dec
Add two floating variables
- bankcash1:Set[${bankcash1}+${bankcash2}]
- bankcash1:Inc[${bankcash2}]
- Note: These two commands are identical
See Also
LavishScript Object Types
- Text
- string - mutablestring - unistring
- Numbers
- byte - float - float64 - int - uint - int64
- Boolean (TRUE/FALSE)
- bool
- Pointers
- boolptr - byteptr - floatptr - float64ptr - intptr - uintptr - int64ptr - rgbptr - stringptr
- Containers
- objectcontainer - array - index - collection - queue - stack - set - variablescope
- JSON
- jsonobject - jsonarray - jsonvaluecontainer - jsonvalue
- Iteration
- iterator - jsoniterator
- Date/Time
- time
- File Handling
- filepath - file - filelist - filelistentry
- Tasks
- lavishmachine - Accessed via the Top-Level Object LMAC
- task - tasklibrary - taskmanager - tasktype - taskpulseargs - elmactaskstate