Python Script Engine  8.3
GL Studio Editor Python Script API
Project Class Reference
+ Inheritance diagram for Project:

Public Member Functions

str GetTopLevelDesignFile ()
 
Kitting::ComparableVersion GetRequiredGLStudioVersion () override
 
None AddToolbarItem (EditorUI::GuiItem *item)
 
None AddObjectButton (EditorUI::Button *button, str group)
 
str GetCurrentDeploymentName ()
 
- Public Member Functions inherited from Kitting::HasRequiredGLStudioVerison
 ~HasRequiredGLStudioVerison ()
 
ComparableVersion GetRequiredGLStudioVersion ()=0
 

Detailed Description

Class representing a Project in the GL Studio editor.

Member Function Documentation

◆ AddObjectButton()

None Project::AddObjectButton ( EditorUI::Button *  button,
str  group 
)

Add a button to the object toolbox.


Parameters
buttonthe button to add.
groupwhich group to add the button to in the object toolbox

◆ AddToolbarItem()

None Project::AddToolbarItem ( EditorUI::GuiItem *  item)

Add an item to the project toolbar.


Parameters
itemthe item to add.

◆ GetCurrentDeploymentName()

str Project::GetCurrentDeploymentName ( )

Return the deployment currently used for the project.

Returns
Current deployment string
Since
GL Studio 6.2.1

◆ GetRequiredGLStudioVersion()

Kitting::ComparableVersion Project::GetRequiredGLStudioVersion ( )
overridevirtual

◆ GetTopLevelDesignFile()

str Project::GetTopLevelDesignFile ( )

Gets the root path of the project, where the project file is located.

Gets the top-level .gls file for the project


The documentation for this class was generated from the following file: