mirror/OpenSpace
1
0
Fork 0
mirror of https://github.com/OpenSpace/OpenSpace.git synced 2025-12-31 00:10:44 -06:00
Code Issues Packages Projects Releases Wiki Activity

Feature/codegen lua (#1906)

Browse Source 
Adapting Lua functions to new codegen functionality
Improve the documentation itself
Add some styling to generated documentation
Have parameter names for Lua-defined Lua function documentation

Co-authored-by: Emma Broman <emma.broman@liu.se>
This commit is contained in:
Alexander Bock
2022-03-21 09:05:37 +01:00
committed by GitHub
parent 6f25dd31e5
commit 3844df20c9
69 changed files with 2656 additions and 4474 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
scripts/core_scripts.lua
View File

@@ -1,34 +1,34 @@
openspace.documentation = {
{
Name = "markInterestingNodes",
Arguments = "List of nodes",
Arguments = { sceneGraphNode = "[ String ]" },
Documentation = "This function marks the scene graph nodes identified by name " ..
"as interesting, which will provide shortcut access to focus buttons and " ..
"featured properties."
},
{
Name = "markInterestingTimes",
Arguments = "List of { Name = '...', Time = '...' } or { '<name>', '<time>' }",
Arguments = { times = "[ Table ]" },
Documentation = "This function marks interesting times for the current scene, " ..
"which will create shortcuts for a quick access."
},
{
Name = "removeInterestingNodes",
Arguments = "List of nodes",
Arguments = { sceneGraphNode = "[ String ]" },
Documentation = "This function removes unmarks the scene graph nodes " ..
"identified by name as interesting, thus removing the shortcuts from the " ..
"features properties list."
},
{
Name = "setDefaultGuiSorting",
Arguments = "",
Arguments = {},
Documentation = "This function sets the default GUI sorting for the space " ..
"environment to increasing size, from solar system, through Milky Way, " ..
"Universe and finishing with other elements"
},
{
Name = "setDefaultDashboard",
Arguments = "",
Arguments = {},
Documentation = "This function sets the default values for the dashboard " ..
"consisting of 'DashboardItemDate', 'DashboardItemSimulationIncrement', " ..
"'DashboardItemDistance', 'DashboardItemFramerate', and " ..
@@ -36,7 +36,7 @@ openspace.documentation = {
},
{
Name = "rebindKey",
Arguments = "string, string",
Arguments = { oldKey = "String", newKey = "String" },
Documentation = "Rebinds all scripts from the old key (first argument) to the " ..
"new key (second argument)."
}