unreal.PCGInstancePackerBase

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

Bases: Object

PCGInstance Packer Base

C++ Source:

  • Plugin: PCG

  • Module: PCG

  • File: PCGInstancePackerBase.h

add_type_to_packing(type_id) PCGPackedCustomData or None

Interprets Metadata TypeId and increments OutPackedCustomData.NumCustomDataFloats appropriately. Returns false if the type could not be interpreted.

Parameters:

type_id (int32) –

Returns:

out_packed_custom_data (PCGPackedCustomData):

Return type:

PCGPackedCustomData or None

pack_custom_data_from_attributes(instance_list, metadata, attribute_names) PCGPackedCustomData

Build a PackedCustomData by processing each attribute in order for each point in the InstanceList

Parameters:
Returns:

out_packed_custom_data (PCGPackedCustomData):

Return type:

PCGPackedCustomData

pack_instances(spatial_data, instance_list) -> (context=PCGContext, out_packed_custom_data=PCGPackedCustomData)

Defines the strategy for (H)ISM custom float data packing

Parameters:
Returns:

context (PCGContext):

out_packed_custom_data (PCGPackedCustomData):

Return type:

tuple