LuaDocs/SceneEditorGUI

From Data Realms Wiki

Has no parent class

Generic Class. A full menu system that represents the scene editing GUI for Cortex Command

Go back to Class Index

Enumerations

EditorGUIMode

• 0 = INACTIVE
• 1 = PICKINGOBJECT
• 2 = ADDINGOBJECT
• 3 = INSTALLINGBRAIN
• 4 = PLACINGOBJECT
• 5 = MOVINGOBJECT
• 6 = DELETINGOBJECT
• 7 = PLACEINFRONT
• 8 = PLACEBEHIND
• 9 = DONEEDITING
• 10 = EDITORGUIMODECOUNT

Functions

SetCursorPos

Sets the absolute scene coordinates of the cursor of this Editor.

Arguments:

• The new cursor position in absolute scene units.

Return value:

None.

GetCurrentObject

Gets the currently held Object in the cursor of this Editor. Ownership IS NOT transferred!

Arguments:

• None.

Return value:

The currently held object, if any. OINT!

SetCurrentObject

Sets the new Object to be held at the cursor of this Editor. Ownership IS transferred!

Arguments:

• The new Object to be held by the cursor. Ownership IS transferred!

Return value:

Whether the cursor holds a valid object after setting.

SetModuleSpace

Sets which DataModule space to be picking objects from. If -1, then let the player pick from all loaded modules.

Arguments:

• The ID of the module to let the player pick objects from. All official modules' objects will alwayws be presented, in addition to the one passed in here.

Return value:

None.

SetNativeTechModule

Sets which DataModule ID should be treated as the native tech of the user of this menu.

Arguments:

• The module ID to set as the native one. 0 means everything is native.

Return value:

None.

SetForeignCostMultiplier

Sets the multiplier of the cost of any foreign Tech items.

Arguments:

• The scalar multiplier of the costs of foreign Tech items.

Return value:

None.

TestBrainResidence

Checks whether the resident brain is currently placed into a valid location in this scene, based on whether there is a clear path to the sky above it. This forces the editor into place brain mode with the current resident brain if the current placement is no bueno. It also removes the faulty brain from residence in the scene!

Arguments:

• Whether it's OK if we dont' have a brain right now - ie don't force into isntallation mode if no brain was found.

Return value:

Whether a resident brain was found, AND found in a valid location!

Update

Updates the state of this Menu each frame

Arguments:

• None.

Return value:

None.

Go back to Class Index