Module Feature.Moon.Moon
Project: Clock – Tamriel Standard Time
Author: Arne Rantzen (Tyx) Created: 2020–01–22 Updated: 2020–03–06 License: GPL-3.0
Functions
| UpdatePositions () | Update the anchor of the moon controls |
| RemoveFragment () | Function to remove the fragment from all scenes and delete the reference |
| UpdateVisibility () | Update the visibility of the moon controls and manage their fragments |
| UpdateMouse () | Update if mouse interactions are possible |
| UpdateBackground () | Update the background texture |
| UpdateTexture (currentPhaseName) | Update the texture of the moons to fit the phases |
| UpdateTooltip (moon) | Update the tooltip information |
| UpdateMoon (moon) | Update the moon texture and tooltip This function is meant to be given to the LibClockTST. |
| RegisterForUpdates () | Register the moon updates with the LibClockTST |
| UnregisterForUpdates () | Stop further updates from the LibClockTST |
| SetupTooltip () | Setup a tooltip to be shown if hovering over the moon control |
| SetupMovement () | Setup the movement of the moon control and link the time control to it if set |
| SetupScale () | Setup a mouse wheel interaction to change the size of the moon |
| SetupControls (control) | Setup the controls and the fragment |
| New (...) | Create a new Moon object |
| Clock_TST:SetupMoon () | function to reload all values from the settings |
Local Functions
| RightClick (control) | Create menu if user clicks right control is the main control |
Functions
- UpdatePositions ()
- Update the anchor of the moon controls
- RemoveFragment ()
- Function to remove the fragment from all scenes and delete the reference
- UpdateVisibility ()
- Update the visibility of the moon controls and manage their fragments
- UpdateMouse ()
- Update if mouse interactions are possible
- UpdateBackground ()
- Update the background texture
- UpdateTexture (currentPhaseName)
-
Update the texture of the moons to fit the phases
Parameters:
- currentPhaseName is the name of the current phase in English
- UpdateTooltip (moon)
-
Update the tooltip information
Parameters:
- moon object { … }
- UpdateMoon (moon)
-
Update the moon texture and tooltip
This function is meant to be given to the LibClockTST.
Parameters:
- moon object { … }
- RegisterForUpdates ()
- Register the moon updates with the LibClockTST
- UnregisterForUpdates ()
- Stop further updates from the LibClockTST
- SetupTooltip ()
- Setup a tooltip to be shown if hovering over the moon control
- SetupMovement ()
- Setup the movement of the moon control and link the time control to it if set
- SetupScale ()
- Setup a mouse wheel interaction to change the size of the moon
- SetupControls (control)
-
Setup the controls and the fragment
Parameters:
- control of the TopLevelControl
- New (...)
-
Create a new Moon object
Parameters:
- ... control of the moon object
- Clock_TST:SetupMoon ()
- function to reload all values from the settings