unreal.ProceduralVegetationGraph

class unreal.ProceduralVegetationGraph(outer: Object | None = None, name: Name | str = 'None')

Bases: PCGGraph

Procedural Vegetation Graph

C++ Source:

  • Plugin: ProceduralVegetationEditor

  • Module: ProceduralVegetation

  • File: ProceduralVegetation.h

Editor Properties: (see get_editor_property/set_editor_property)

  • auto_refresh_on_quality_settings_changed (bool): [Read-Write] Auto-refresh when engine scalability settings or the pcg.Quality CVar change. Disable for slow CPU-generated graphs that shouldn’t tear down on quality toggles.

  • auto_refresh_on_render_state_refresh (bool): [Read-Write] Auto-refresh on render-state events: viewport resize, component re-register, scene material change, preview platform change, fast-geo recreate. Disable for slow CPU-generated graphs that should survive incidental render-state churn.

  • category (Text): [Read-Write]

  • change_tracking_ignored_classes (Array[type(Class)]): [Read-Write]

  • color (LinearColor): [Read-Write] Override of the color for the subgraph node for this graph.

  • console_variables_triggering_refresh (Array[str]): [Read-Write] Console variable names that trigger a runtime PCG refresh of this graph when any of their values change. Disabled in shipping game builds.

  • debug_flag_applies_to_individual_components (bool): [Read-Write] When true the Debug flag in the graph editor will display debug information contextually for the selected debug object. Otherwise debug information is displayed for all components using a graph (requires regenerate).

  • description (Text): [Read-Write]

  • expose_to_library (bool): [Read-Write]

  • generation_radii (PCGRuntimeGenerationRadii): [Read-Write]

  • graph_customization (PCGGraphEditorCustomization): [Read-Write]

  • graph_usage_context (PCGGraphUsage): [Read-Write] Controls whether a graph can be executed outside of the context of a PCG actor/entity, e.g. run on for asset or level workflows.

  • has_default_constructed_inputs (bool): [Read-Write] Controls whether the default pins (In, …) are provided data on top-level graphs automatically. Note this will eventually change to be turned off by default.

  • hi_gen_grid_size (PCGHiGenGrid): [Read-Write]

  • hi_gen_grid_size_multiplier (double): [Read-Write] Scales the grid sizes allowing to use larger or smaller grids than those provided out of the box. Can be useful to align generation to other grids in the world.

  • ignore_landscape_tracking (bool): [Read-Write] Marks the graph to be not refreshed automatically when the landscape changes, even if it is used.

  • input_node (PCGNode): [Read-Write] Add input/output nodes

  • is_standalone_graph (bool): [Read-Write] deprecated: Deprecated in favor of GraphUsageContext

  • is_template (bool): [Read-Write]

  • landscape_uses_metadata (bool): [Read-Write]

  • nodes (Array[PCGNode]): [Read-Write]

  • output_node (PCGNode): [Read-Write]

  • override_color (bool): [Read-Write]

  • override_title (bool): [Read-Write]

  • should_cook (PerPlatformBool): [Read-Write] Controls whether this PCG graph is included when cooking for each platform. If disabled, the graph and all of its compiled data (compute graphs, kernel sources, pins, nodes, edges) will be stripped from cooked builds. Any PCG components or graph instances that reference this graph will also be excluded from cooking.

    Not exposed on embedded subgraphs: the cook decision is inherited from the parent graph.

  • title (Text): [Read-Write] Override of the title for the subgraph node for this graph.

  • tool_data (PCGGraphToolData): [Read-Write] Contains the data relevant for PCG Editor Mode usage.

  • use2d_grid (bool): [Read-Write]

  • use_actor_componentless_generation (bool): [Read-Write] [EXPERIMENTAL] Avoids creating partition actors and local PCG components. Any functionality which depends on a target actor/component are not supported in this mode.

  • use_hierarchical_generation (bool): [Read-Write]

  • user_parameters (InstancedPropertyBag): [Read-Write] Parameters