Module Data.Settings
Project: Clock – Tamriel Standard Time
Author: Arne Rantzen (Tyx) Created: 2020–01–22 Updated: 2020–03–06 License: GPL-3.0
Functions
GetSaveAccountWide () | a function to get the stored boolean value for the core elements |
SetSaveAccountWide (value) | a function to store the boolean value for the core elements |
GetVersion () | a function to get the current version as numbers |
GetLastVersion () | a function to get last stored version |
SetLastVersion (major, minor, patch) | a function to store the last version |
GetDebug () | a function to get the stored boolean value for the core elements since 2.2.0 |
SetDebug (value) | a function to store the boolean value for the core elements since 2.2.0 |
GetTimeAndMoonAreLinked () | a function to get the stored boolean value for the core elements if it is linked to time, the moon moves with the time object |
SetTimeAndMoonAreLinked (value) | a function to store the boolean value for the core elements |
GetHideInGroup () | a function to get the stored boolean value for the core elements |
SetHideInGroup (value) | a function to store the boolean value for the core elements |
GetHideInCombat () | a function to get the stored boolean value for the core elements |
SetHideInCombat (value) | a function to store the boolean value for the core elements |
GetOnlyShowOnMap () | a function to get the stored boolean value for the core elements |
SetOnlyShowOnMap (value) | a function to store the boolean value for the core elements |
GetTimeIsVisible () | a function to get the stored boolean value for the time |
SetTimeIsVisible (value) | a function to store the boolean value for the time |
GetTimeIsMouseEnabled () | a function to get the stored boolean value for the time |
SetTimeIsMouseEnabled (value) | a function to store the boolean value for the time |
GetTimeIsMovable () | a function to get the stored boolean value for the time |
SetTimeIsMovable (value) | a function to store the boolean value for the time |
GetTimeHasTooltip () | a function to get the stored boolean value for the time |
SetTimeHasTooltip (value) | a function to store the boolean value for the time |
GetTimeHasBackground () | a function to get the stored boolean value for the time |
SetTimeHasBackground (value) | a function to store the boolean value for the time |
GetTimeAddZero () | a function to get the stored boolean value for the time |
SetTimeAddZero (value) | a function to store the boolean value for the time |
GetTimeHasUSFormat () | a function to get the stored boolean value for the time |
SetTimeHasUSFormat (value) | a function to store the boolean value for the time |
GetTimeHasJapFormat () | a function to get the stored boolean value for the time |
SetTimeHasJapFormat (value) | a function to store the boolean value for the time |
GetTimeHasLoreDate () | a function to get the stored boolean value for the time |
SetTimeHasLoreDate (value) | a function to store the boolean value for the time |
GetTimeHasFakeLoreDate () | a function to get the stored boolean value for the time |
SetTimeHasFakeLoreDate (value) | a function to store the boolean value for the time |
GetTimeHasRealDate () | a function to get the stored boolean value for the time |
SetTimeHasRealDate (value) | a function to store the boolean value for the time |
GetTimeTooltipHasLoreDate () | a function to get the stored boolean value for the time |
SetTimeTooltipHasLoreDate (value) | a function to store the boolean value for the time |
GetTimeTooltipHasFakeLoreDate () | a function to get the stored boolean value for the time |
SetTimeTooltipHasFakeLoreDate (value) | a function to store the boolean value for the time |
GetTimeTooltipHasRealDate () | a function to get the stored boolean value for the time |
SetTimeTooltipHasRealDate (value) | a function to store the boolean value for the time |
GetTimeScaleWhenHover () | a function to get the stored boolean value for the time |
SetTimeScaleWhenHover (value) | a function to store the boolean value for the time |
GetTimeHighlightWhenHover () | a function to get the stored boolean value for the time |
SetTimeHighlightWhenHover (value) | a function to store the boolean value for the time |
GetMoonIsVisible () | a function to get the stored boolean value for the moon |
SetMoonIsVisible (value) | a function to store the boolean value for the moon |
GetMoonIsMouseEnabled () | a function to get the stored boolean value for the moon |
SetMoonIsMouseEnabled (value) | a function to store the boolean value for the moon |
GetMoonIsMovable () | a function to get the stored boolean value for the moon |
SetMoonIsMovable (value) | a function to store the boolean value for the moon |
GetMoonHasBackground () | a function to get the stored boolean value for the moon |
SetMoonHasBackground (value) | a function to store the boolean value for the moon |
GetMoonHasTooltip () | a function to get the stored boolean value for the moon |
SetMoonHasTooltip (value) | a function to store the boolean value for the moon |
GetMoonScaleWhenHover () | a function to get the stored boolean value for the moon |
SetMoonScaleWhenHover (value) | a function to store the boolean value for the moon |
GetMoonHighlightWhenHover () | a function to get the stored boolean value for the moon |
SetMoonHighlightWhenHover (value) | a function to store the boolean value for the moon |
GetTimeFormat () | a function to get the stored style value for the time |
SetTimeFormat (value) | a function to store the style value for the moon |
GetTimeTooltipFormat () | a function to get the stored style value for the time |
SetTimeTooltipFormat (value) | a function to store the style value for the moon |
GetTimeSize () | a function to get the stored style value for the time |
SetTimeSize (value) | a function to store the style value for the moon |
GetTimeColour () | a function to get the stored style value for the time |
SetTimeColour (r, g, b, a) | a function to store the style value for the moon |
GetTimeFont () | a function to get the stored style value for the time |
SetTimeFont (value) | a function to store the style value for the moon |
GetTimeStyle () | a function to get the stored style value for the time |
SetTimeStyle (value) | a function to store the style value for the moon |
GetTimeLineCount () | a function to get the stored style value for the time |
SetTimeLineCount (value) | a function to store the style value for the moon |
GetTimeBackground () | a function to get the stored style value for the time |
SetTimeBackground (value) | a function to store the style value for the time |
GetTimeBackgroundColour () | a function to get the stored style value for the time since 2.1.0 |
SetTimeBackgroundColour (r, g, b, a) | a function to store the style value for the moon since 2.1.0 |
GetTimeBackgroundHoverColour () | a function to get the stored style value for the time since 2.1.0 |
SetTimeBackgroundHoverColour (r, g, b, a) | a function to store the style value for the moon since 2.1.0 |
GetTimeBackgroundOffset () | a function to get the stored style value for the time |
SetTimeBackgroundOffset (value) | a function to store the style value for the time |
GetMoonBackground () | a function to get the stored style value for the moon |
SetMoonBackground (value) | a function to store the style value for the moon |
GetMoonBackgroundColour () | a function to get the stored style value for the moon since 2.1.0 |
SetMoonBackgroundColour (r, g, b, a) | a function to store the style value for the moon since 2.1.0 |
GetMoonBackgroundHoverColour () | a function to get the stored style value for the moon since 2.1.0 |
SetMoonBackgroundHoverColour (r, g, b, a) | a function to store the style value for the moon since 2.1.0 |
GetMoonTextureKeyMasser () | a function to get the stored style value for the moon |
SetMoonTextureKeyMasser (value) | a function to store the style value for the moon |
GetMoonTextureKeySecunda () | a function to get the stored style value for the moon |
SetMoonTextureKeySecunda (value) | a function to store the style value for the moon |
GetMoonAlpha () | a function to get the stored style value for the moon |
SetMoonAlpha (value) | a function to store the style value for the moon |
GetScaleFactor () | a function to get the stored scale factor |
SetScaleFactor (value) | a function to store the scale factor |
GetTimeAttributes () | a function to get the current attributes for the time. |
GetTimeOffset () | a function to get the current offset of the time |
SetTimeOffset (x, y) | a function to save the current offset of the time |
GetTimeDimension () | a function to get the current dimension for the time. |
SetTimeDimension (value) | a function to get the current dimension for the time. |
GetMoonAttributes () | a function to get the current attributes for the moon. |
GetMoonAnchor () | a function to get the current moon anchor |
GetMoonOffset () | a function to get the current offset of the moon |
SetMoonOffset (x, y) | a function to save the current offset of the moon |
GetMoonDimension () | a function to get the current dimension for the moon. |
SetMoonDimension (value) | a function to get the current dimension for the moon. |
GetMoonMasserAttributes () | a function to get the current attributes for the moon Masser. |
GetMoonSecundaAttributes () | a function to get the current attributes for the moon Secunda. |
GetMoonScale () | a function to get the stored scale |
SetMoonScale (value) | a function to store the scale |
GetPresets () | Function to get a list of all presets since 2.2.2 |
ApplyPreset (key) | Function to apply a specific preset since 2.2.2 |
AddPreset (key) | Function to add a new preset since 2.2.2 |
RemovePreset (key) | Function to remove a preset since 2.2.2 |
GetCurrentPreset () | Function to get the current preset since 2.2.2 |
SetCurrentPreset (key) | Function to set the current preset since 2.2.2 |
CurrentPresetExists () | Function to find out if the current preset already exists since 2.2.2 |
ResetAttributes () | Resets the attributes table to the default values |
ResetBooleans () | Resets the booleans table to the default values |
ResetStyles () | Resets the styles table to the default values |
ResetPresets () | Resets the preset table to the default values since 2.2.2 |
Reset () | Resets the self table to the default values |
Migrate () | Function to migrate saved variables to latest version without having to reset it |
New () | Load the SavedVariables or register the default values. |
Functions
- GetSaveAccountWide ()
-
a function to get the stored boolean value for the core elements
Returns:
-
boolean if the saved variable is account wide
- SetSaveAccountWide (value)
-
a function to store the boolean value for the core elements
Parameters:
- value boolean if the saved variable is account wide
- GetVersion ()
-
a function to get the current version as numbers
Returns:
- number major version
- number minor version
- number patch version
- GetLastVersion ()
-
a function to get last stored version
Returns:
- number major version
- number minor version
- number patch version
- SetLastVersion (major, minor, patch)
-
a function to store the last version
Parameters:
- major number version
- minor number version
- patch number version
- GetDebug ()
-
a function to get the stored boolean value for the core elements
since 2.2.0
Returns:
-
boolean if the debug mode is enabled
- SetDebug (value)
-
a function to store the boolean value for the core elements
since 2.2.0
Parameters:
- value boolean if the debug mode is enabled
- GetTimeAndMoonAreLinked ()
-
a function to get the stored boolean value for the core elements
if it is linked to time, the moon moves with the time object
Returns:
-
boolean if the moon is linked to time
- SetTimeAndMoonAreLinked (value)
-
a function to store the boolean value for the core elements
Parameters:
- value boolean if the moon is linked to time
- GetHideInGroup ()
-
a function to get the stored boolean value for the core elements
Returns:
-
boolean if the view should be hidden in groups
- SetHideInGroup (value)
-
a function to store the boolean value for the core elements
Parameters:
- value boolean if the view should be hidden in groups
- GetHideInCombat ()
-
a function to get the stored boolean value for the core elements
Returns:
-
boolean if the view should be hidden in fights
- SetHideInCombat (value)
-
a function to store the boolean value for the core elements
Parameters:
- value boolean if the view should be hidden in fights
- GetOnlyShowOnMap ()
-
a function to get the stored boolean value for the core elements
Returns:
-
boolean if the view should be only visible on the map
- SetOnlyShowOnMap (value)
-
a function to store the boolean value for the core elements
Parameters:
- value boolean if the view should be only visible on the map
- GetTimeIsVisible ()
-
a function to get the stored boolean value for the time
Returns:
-
boolean if the time is visible
- SetTimeIsVisible (value)
-
a function to store the boolean value for the time
Parameters:
- value boolean if the time is visible
- GetTimeIsMouseEnabled ()
-
a function to get the stored boolean value for the time
Returns:
-
boolean if the time is mouseEnabled
- SetTimeIsMouseEnabled (value)
-
a function to store the boolean value for the time
Parameters:
- value boolean if the time is mouseEnabled
- GetTimeIsMovable ()
-
a function to get the stored boolean value for the time
Returns:
-
boolean if the time is movable
- SetTimeIsMovable (value)
-
a function to store the boolean value for the time
Parameters:
- value boolean if the time is movable
- GetTimeHasTooltip ()
-
a function to get the stored boolean value for the time
Returns:
-
boolean if the time has tooltip
- SetTimeHasTooltip (value)
-
a function to store the boolean value for the time
Parameters:
- value boolean if the time has tooltip
- GetTimeHasBackground ()
-
a function to get the stored boolean value for the time
Returns:
-
boolean if the time has background
- SetTimeHasBackground (value)
-
a function to store the boolean value for the time
Parameters:
- value boolean if the time has background
- GetTimeAddZero ()
-
a function to get the stored boolean value for the time
Returns:
-
boolean if a 0 should be added before a single digit
- SetTimeAddZero (value)
-
a function to store the boolean value for the time
Parameters:
- value boolean if a 0 should be added before a single digit
- GetTimeHasUSFormat ()
-
a function to get the stored boolean value for the time
Returns:
-
boolean if the time has US format {12,1,…,11} am : {12,1,…,11} pm
- SetTimeHasUSFormat (value)
-
a function to store the boolean value for the time
Parameters:
- value boolean if the time has the US format
- GetTimeHasJapFormat ()
-
a function to get the stored boolean value for the time
Returns:
-
boolean if the time has Japanese format {0,1,…,11} am : {12,1,…,11} pm
- SetTimeHasJapFormat (value)
-
a function to store the boolean value for the time
Parameters:
- value boolean if the time has the Japanese format
- GetTimeHasLoreDate ()
-
a function to get the stored boolean value for the time
Returns:
-
boolean if the time has a lore date
- SetTimeHasLoreDate (value)
-
a function to store the boolean value for the time
Parameters:
- value
Returns:
-
boolean if the time has a lore date
- GetTimeHasFakeLoreDate ()
-
a function to get the stored boolean value for the time
Returns:
-
boolean if the time has a fake lore date
- SetTimeHasFakeLoreDate (value)
-
a function to store the boolean value for the time
Parameters:
- value
Returns:
-
boolean if the time has a fake lore date
- GetTimeHasRealDate ()
-
a function to get the stored boolean value for the time
Returns:
-
boolean if the time has a real date
- SetTimeHasRealDate (value)
-
a function to store the boolean value for the time
Parameters:
- value
Returns:
-
boolean if the time has a real date
- GetTimeTooltipHasLoreDate ()
-
a function to get the stored boolean value for the time
Returns:
-
boolean if the time tooltip has a lore date
- SetTimeTooltipHasLoreDate (value)
-
a function to store the boolean value for the time
Parameters:
- value
Returns:
-
boolean if the time tooltip has a lore date
- GetTimeTooltipHasFakeLoreDate ()
-
a function to get the stored boolean value for the time
Returns:
-
boolean if the time tooltip has a fake lore date
- SetTimeTooltipHasFakeLoreDate (value)
-
a function to store the boolean value for the time
Parameters:
- value
Returns:
-
boolean if the time tooltip has a fake lore date
- GetTimeTooltipHasRealDate ()
-
a function to get the stored boolean value for the time
Returns:
-
boolean if the time tooltip has a real date
- SetTimeTooltipHasRealDate (value)
-
a function to store the boolean value for the time
Parameters:
- value
Returns:
-
boolean if the time tooltip has a real date
- GetTimeScaleWhenHover ()
-
a function to get the stored boolean value for the time
Returns:
-
boolean if the time should scale up when hovering over
- SetTimeScaleWhenHover (value)
-
a function to store the boolean value for the time
Parameters:
- value boolean if the time should scale up when hovering over
- GetTimeHighlightWhenHover ()
-
a function to get the stored boolean value for the time
Returns:
-
boolean if the time should change colour when hovering over
- SetTimeHighlightWhenHover (value)
-
a function to store the boolean value for the time
Parameters:
- value boolean if the time should change colour when hovering over
- GetMoonIsVisible ()
-
a function to get the stored boolean value for the moon
Returns:
-
boolean if the moon is visible
- SetMoonIsVisible (value)
-
a function to store the boolean value for the moon
Parameters:
- value boolean if the moon is visible
- GetMoonIsMouseEnabled ()
-
a function to get the stored boolean value for the moon
Returns:
-
boolean if the moon is mouseEnabled
- SetMoonIsMouseEnabled (value)
-
a function to store the boolean value for the moon
Parameters:
- value boolean if the moon is mouseEnabled
- GetMoonIsMovable ()
-
a function to get the stored boolean value for the moon
Returns:
-
boolean if the moon is movable
- SetMoonIsMovable (value)
-
a function to store the boolean value for the moon
Parameters:
- value boolean if the moon is movable
- GetMoonHasBackground ()
-
a function to get the stored boolean value for the moon
Returns:
-
boolean if the moon has background
- SetMoonHasBackground (value)
-
a function to store the boolean value for the moon
Parameters:
- value boolean if the moon has background
- GetMoonHasTooltip ()
-
a function to get the stored boolean value for the moon
Returns:
-
boolean if the moon has tooltip
- SetMoonHasTooltip (value)
-
a function to store the boolean value for the moon
Parameters:
- value boolean if the moon has tooltip
- GetMoonScaleWhenHover ()
-
a function to get the stored boolean value for the moon
Returns:
-
boolean if the moon should scale up when hovering over
- SetMoonScaleWhenHover (value)
-
a function to store the boolean value for the moon
Parameters:
- value boolean if the moon should scale up when hovering over
- GetMoonHighlightWhenHover ()
-
a function to get the stored boolean value for the moon
Returns:
-
boolean if the moon should change colour when hovering over
- SetMoonHighlightWhenHover (value)
-
a function to store the boolean value for the moon
Parameters:
- value boolean if the moon should change colour when hovering over
- GetTimeFormat ()
-
a function to get the stored style value for the time
Returns:
-
string the format for the time
- SetTimeFormat (value)
-
a function to store the style value for the moon
Parameters:
- value string the format for the time
- GetTimeTooltipFormat ()
-
a function to get the stored style value for the time
Returns:
-
string the format for the time tooltip
- SetTimeTooltipFormat (value)
-
a function to store the style value for the moon
Parameters:
- value string the format for the time tooltip
- GetTimeSize ()
-
a function to get the stored style value for the time
Returns:
-
number the size for the time
- SetTimeSize (value)
-
a function to store the style value for the moon
Parameters:
- value number the size for the time
- GetTimeColour ()
-
a function to get the stored style value for the time
Returns:
- number r red colour
- number g green colour
- number b blue colour
- number a alpha value
- SetTimeColour (r, g, b, a)
-
a function to store the style value for the moon
Parameters:
- r number red colour
- g number green colour
- b number blue colour
- a number alpha value
- GetTimeFont ()
-
a function to get the stored style value for the time
Returns:
-
string the font for the time
- SetTimeFont (value)
-
a function to store the style value for the moon
Parameters:
- value string the font for the time
- GetTimeStyle ()
-
a function to get the stored style value for the time
Returns:
-
string the style for the time
- SetTimeStyle (value)
-
a function to store the style value for the moon
Parameters:
- value string the style for the time
- GetTimeLineCount ()
-
a function to get the stored style value for the time
Returns:
-
number the line count for the time
- SetTimeLineCount (value)
-
a function to store the style value for the moon
Parameters:
- value number the line count for the time
- GetTimeBackground ()
-
a function to get the stored style value for the time
Returns:
-
string background texture table key
- SetTimeBackground (value)
-
a function to store the style value for the time
Parameters:
- value table key for background name
- GetTimeBackgroundColour ()
-
a function to get the stored style value for the time
since 2.1.0
Returns:
- number r red colour
- number g green colour
- number b blue colour
- number a alpha value
- SetTimeBackgroundColour (r, g, b, a)
-
a function to store the style value for the moon
since 2.1.0
Parameters:
- r number red colour
- g number green colour
- b number blue colour
- a number alpha value
- GetTimeBackgroundHoverColour ()
-
a function to get the stored style value for the time
since 2.1.0
Returns:
- number r red colour
- number g green colour
- number b blue colour
- number a alpha value
- SetTimeBackgroundHoverColour (r, g, b, a)
-
a function to store the style value for the moon
since 2.1.0
Parameters:
- r number red colour
- g number green colour
- b number blue colour
- a number alpha value
- GetTimeBackgroundOffset ()
-
a function to get the stored style value for the time
Returns:
-
number background width offset
- SetTimeBackgroundOffset (value)
-
a function to store the style value for the time
Parameters:
- value number background width offset
- GetMoonBackground ()
-
a function to get the stored style value for the moon
Returns:
-
string background texture table key
- SetMoonBackground (value)
-
a function to store the style value for the moon
Parameters:
- value string background texture table key
- GetMoonBackgroundColour ()
-
a function to get the stored style value for the moon
since 2.1.0
Returns:
- number r red colour
- number g green colour
- number b blue colour
- number a alpha value
- SetMoonBackgroundColour (r, g, b, a)
-
a function to store the style value for the moon
since 2.1.0
Parameters:
- r number red colour
- g number green colour
- b number blue colour
- a number alpha value
- GetMoonBackgroundHoverColour ()
-
a function to get the stored style value for the moon
since 2.1.0
Returns:
- number r red colour
- number g green colour
- number b blue colour
- number a alpha value
- SetMoonBackgroundHoverColour (r, g, b, a)
-
a function to store the style value for the moon
since 2.1.0
Parameters:
- r number red colour
- g number green colour
- b number blue colour
- a number alpha value
- GetMoonTextureKeyMasser ()
-
a function to get the stored style value for the moon
Returns:
-
table key for masser texture
- SetMoonTextureKeyMasser (value)
-
a function to store the style value for the moon
Parameters:
- value table key for masser texture
- GetMoonTextureKeySecunda ()
-
a function to get the stored style value for the moon
Returns:
-
table key for secunda texture
- SetMoonTextureKeySecunda (value)
-
a function to store the style value for the moon
Parameters:
- value table key for secunda texture
- GetMoonAlpha ()
-
a function to get the stored style value for the moon
Returns:
-
number value of how much the moon texture is visible
- SetMoonAlpha (value)
-
a function to store the style value for the moon
Parameters:
- value number of how much the moon texture is visible
- GetScaleFactor ()
-
a function to get the stored scale factor
Returns:
-
number range (-inf:inf)
- SetScaleFactor (value)
-
a function to store the scale factor
Parameters:
- value number range (-inf:inf)
- GetTimeAttributes ()
-
a function to get the current attributes for the time.
Inside are also the attribute tables of label and background.
Returns:
-
table time = {
anchor = { point, relativeTo, relativePoint, offsetX, offsetY, }, dimension = { width, height, }, background = { anchor = { point, relativeTo, relativePoint, offsetX, offsetY, }, dimension = { width, height, }, background = { anchor = { point, relativeTo, relativePoint, offsetX, offsetY, }, dimension = { width, height, }, }, }, label = { anchor = { point, relativeTo, relativePoint, offsetX, offsetY, }, dimension = { width, height, }, background = { anchor = { point, relativeTo, relativePoint, offsetX, offsetY, }, dimension = { width, height, }, }, },
}
- GetTimeOffset ()
-
a function to get the current offset of the time
Returns:
- number offsetX
- number offsetY
- SetTimeOffset (x, y)
-
a function to save the current offset of the time
Parameters:
- x number offset
- y number offset
- GetTimeDimension ()
-
a function to get the current dimension for the time.
Returns:
-
table dimension = { width, height, }
- SetTimeDimension (value)
-
a function to get the current dimension for the time.
Parameters:
- value table dimension = { width, height, }
- GetMoonAttributes ()
-
a function to get the current attributes for the moon.
Inside are also the attribute tables of Secunda and Masser.
Returns:
-
table moon = {
anchor = { point, relativeTo, relativePoint, offsetX, offsetY, }, dimension = { width, height, }, masser = { anchor = { point, relativeTo, relativePoint, offsetX, offsetY, }, dimension = { width, height, }, background = { anchor = { point, relativeTo, relativePoint, offsetX, offsetY, }, dimension = { width, height, }, }, }, secunda = { anchor = { point, relativeTo, relativePoint, offsetX, offsetY, }, dimension = { width, height, }, background = { anchor = { point, relativeTo, relativePoint, offsetX, offsetY, }, dimension = { width, height, }, }, },
}
- GetMoonAnchor ()
-
a function to get the current moon anchor
Returns:
-
table anchor = { point, relativeTo, relativePoint, offsetX, offsetY, }
- GetMoonOffset ()
-
a function to get the current offset of the moon
Returns:
- number offsetX
- number offsetY
- SetMoonOffset (x, y)
-
a function to save the current offset of the moon
Parameters:
- x number offset
- y number offset
- GetMoonDimension ()
-
a function to get the current dimension for the moon.
Returns:
-
table dimension = { width, height, }
- SetMoonDimension (value)
-
a function to get the current dimension for the moon.
Parameters:
- value table dimension = { width, height, }
- GetMoonMasserAttributes ()
-
a function to get the current attributes for the moon Masser.
Returns:
-
table masser = {
anchor = { point, relativeTo, relativePoint, offsetX, offsetY, }, dimension = { width, height, }, background = { anchor = { point, relativeTo, relativePoint, offsetX, offsetY, }, dimension = { width, height, },
}
- GetMoonSecundaAttributes ()
-
a function to get the current attributes for the moon Secunda.
Returns:
-
table secunda = {
anchor = { point, relativeTo, relativePoint, offsetX, offsetY, }, dimension = { width, height, }, background = { anchor = { point, relativeTo, relativePoint, offsetX, offsetY, }, dimension = { width, height, },
}
- GetMoonScale ()
-
a function to get the stored scale
Returns:
-
number range [0, inf)
- SetMoonScale (value)
-
a function to store the scale
Parameters:
- value number range [0, inf)
- GetPresets ()
-
Function to get a list of all presets
since 2.2.2
Returns:
-
table of preset keys
- ApplyPreset (key)
-
Function to apply a specific preset
since 2.2.2
Parameters:
- key string of the preset
- AddPreset (key)
-
Function to add a new preset
since 2.2.2
Parameters:
- key string of the new preset
- RemovePreset (key)
-
Function to remove a preset
since 2.2.2
Parameters:
- key string of the preset
- GetCurrentPreset ()
-
Function to get the current preset
since 2.2.2
Returns:
-
string current preset key
- SetCurrentPreset (key)
-
Function to set the current preset
since 2.2.2
Parameters:
- key string for preset
- CurrentPresetExists ()
- Function to find out if the current preset already exists since 2.2.2
- ResetAttributes ()
- Resets the attributes table to the default values
- ResetBooleans ()
- Resets the booleans table to the default values
- ResetStyles ()
- Resets the styles table to the default values
- ResetPresets ()
- Resets the preset table to the default values since 2.2.2
- Reset ()
- Resets the self table to the default values
- Migrate ()
- Function to migrate saved variables to latest version without having to reset it
- New ()
- Load the SavedVariables or register the default values.