Methods Signatures
Retrieves the width of the custom GUI in pixels. |
|
Retrieves the height of the custom GUI in pixels. |
|
Redraws the custom GUI. |
|
Tells the custom GUI that the layout has changed. |
|
Activates the custom GUI. |
|
Sets the custom GUI to the resource editor defaults. |
|
Sets the custom GUI data. |
|
Retrieves the custom GUI data. |
|
Sets the layout mode. |
|
Retrieves the layout mode. |
|
Checks if the custom GUI supports layout switching. |
Inheritance
Children Classes:
Methods Documentation
-
BaseCustomGui.
GetWidth
(self)¶ Retrieves the width of the custom GUI in pixels.
New in version R18.011.
- Return type
int
- Returns
The width of the custom GUI.
-
BaseCustomGui.
GetHeight
(self)¶ Retrieves the height of the custom GUI in pixels.
New in version R18.011.
- Return type
int
- Returns
The height of the custom GUI.
-
BaseCustomGui.
Redraw
(self)¶ Redraws the custom GUI.
New in version R18.011.
-
BaseCustomGui.
LayoutChanged
(self)¶ Tells the custom GUI that the layout has changed.
New in version R18.011.
- Return type
bool
- Returns
True if successful, otherwise False.
-
BaseCustomGui.
Activate
(self)¶ Activates the custom GUI.
New in version R18.011.
- Return type
bool
- Returns
True if successful, otherwise False.
-
BaseCustomGui.
SetDefaultForResEdit
(self)¶ Sets the custom GUI to the resource editor defaults.
New in version R18.011.
- Return type
bool
- Returns
True if successful, otherwise False.
-
BaseCustomGui.
SetData
(self, data)¶ Sets the custom GUI data.
New in version R18.011.
- Parameters
data (any) – The new data.
- Return type
bool
- Returns
True if successful, otherwise False.
-
BaseCustomGui.
GetData
(self)¶ Retrieves the custom GUI data.
New in version R18.011.
- Return type
Any
- Returns
The current data.
-
BaseCustomGui.
SetLayoutMode
(self, mode)¶ Sets the layout mode.
New in version R18.011.
- Parameters
mode (int) –
The new layout mode:
LAYOUTMODE_NONE
Does not support layout modes.
LAYOUTMODE_MINIMIZED
Minimized.
LAYOUTMODE_MAXIMIZED
Maximized.
-
BaseCustomGui.
GetLayoutMode
(self)¶ Retrieves the layout mode.
New in version R18.011.
- Return type
int
- Returns
The current layout mode:
LAYOUTMODE_NONE
Does not support layout modes.
LAYOUTMODE_MINIMIZED
Minimized.
LAYOUTMODE_MAXIMIZED
Maximized.
-
BaseCustomGui.
SupportLayoutSwitch
(self)¶ Checks if the custom GUI supports layout switching.
New in version R18.011.
- Return type
bool
- Returns
True if the layout switch is supported, otherwise False.