unreal.AvaViewportSettings
¶
- class unreal.AvaViewportSettings(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
DeveloperSettings
Ava Viewport Settings
C++ Source:
Plugin: Avalanche
Module: AvalancheViewport
File: AvaViewportSettings.h
Editor Properties: (see get_editor_property/set_editor_property)
camera_bounds_shade_color
(LinearColor): [Read-Write]disabled_guide_color
(LinearColor): [Read-Write]disabled_locked_guide_color
(LinearColor): [Read-Write]dragged_guide_color
(LinearColor): [Read-Write]enable_bounding_boxes
(bool): [Read-Write]enable_shapes_editor_overlay
(bool): [Read-Write]enable_viewport_overlay
(bool): [Read-Write]enabled_guide_color
(LinearColor): [Read-Write]enabled_locked_guide_color
(LinearColor): [Read-Write]grid_always_visible
(bool): [Read-Write]grid_color
(LinearColor): [Read-Write]grid_enabled
(bool): [Read-Write]grid_size
(int32): [Read-Write]grid_thickness
(float): [Read-Write]guide_config_path
(str): [Read-Write] Directory used to load and save guide json config files.The path will be checked against 3 possible locations: - Just itself (/Config/Guides) - Project (/Path/To/Project/Config/Guides) - Plugin (/Path/To/Plugin/Config/Guides)
Example values: - /Config/Guides - D:UnrealEngineConfigGuides
guide_thickness
(float): [Read-Write]guides_enabled
(bool): [Read-Write]pixel_grid_color
(LinearColor): [Read-Write]pixel_grid_enabled
(bool): [Read-Write]safe_frames
(Array[AvaLevelViewportSafeFrame]): [Read-Write]safe_frames_enabled
(bool): [Read-Write]shape_editor_overlay_type
(AvaShapeEditorOverlayType): [Read-Write] Whether to show or hide the Shapes In-Viewport controls.snap_indicator_color
(LinearColor): [Read-Write]snap_indicator_thickness
(float): [Read-Write]snap_indicators_enabled
(bool): [Read-Write]snap_state
(int32): [Read-Write]viewport_background_material
(Material): [Read-Write]viewport_checkerboard_color0
(LinearColor): [Read-Write]viewport_checkerboard_color1
(LinearColor): [Read-Write]viewport_checkerboard_material
(Material): [Read-Write]viewport_checkerboard_size
(float): [Read-Write]
- property camera_bounds_shade_color: LinearColor¶
[Read-Write]
- Type:
- property disabled_guide_color: LinearColor¶
[Read-Write]
- Type:
- property disabled_locked_guide_color: LinearColor¶
[Read-Write]
- Type:
- property dragged_guide_color: LinearColor¶
[Read-Write]
- Type:
- property enabled_guide_color: LinearColor¶
[Read-Write]
- Type:
- property enabled_locked_guide_color: LinearColor¶
[Read-Write]
- Type:
- get_snap_state() AvaViewportSnapState ¶
Get Snap State
- Return type:
- property grid_color: LinearColor¶
[Read-Write]
- Type:
- property guide_config_path: str¶
[Read-Write] Directory used to load and save guide json config files.
The path will be checked against 3 possible locations: - Just itself (/Config/Guides) - Project (/Path/To/Project/Config/Guides) - Plugin (/Path/To/Plugin/Config/Guides)
Example values: - /Config/Guides - D:UnrealEngineConfigGuides
- Type:
(str)
- has_snap_state(snap_state) bool ¶
Has Snap State
- Parameters:
snap_state (AvaViewportSnapState) –
- Return type:
- property pixel_grid_color: LinearColor¶
[Read-Write]
- Type:
- set_snap_state(snap_state) None ¶
Set Snap State
- Parameters:
snap_state (AvaViewportSnapState) –
- property shape_editor_overlay_type: AvaShapeEditorOverlayType¶
[Read-Write] Whether to show or hide the Shapes In-Viewport controls.
- Type:
- property snap_indicator_color: LinearColor¶
[Read-Write]
- Type:
- property viewport_checkerboard_color0: LinearColor¶
[Read-Write]
- Type:
- property viewport_checkerboard_color1: LinearColor¶
[Read-Write]
- Type: