Class BlueprintDraft

Namespace

VoxelPlayground.Gaming

Assembly

GamePlay.dll

Draft for saving a blueprint. Holds selected entities and provides save functionality. Created when entering blueprint save mode, cleared when saved or cancelled.

public class BlueprintDraft

Inheritance

object

BlueprintDraft

Fields

selectedRootEntities

public List<EntityAttachmentItem> selectedRootEntities

Field Value

List<EntityAttachmentItem>

Properties

EntityCount

Get total number of selected entities

public int EntityCount { get; }

Property Value

int

GroupCount

Get number of selected groups

public int GroupCount { get; }

Property Value

int

selectedRootEntity

public EntityAttachmentItem selectedRootEntity { get; }

Property Value

EntityAttachmentItem

Methods

ClearAll()

Clear all selections and highlights

public void ClearAll()

DeselectEntity(EntityAttachmentItem)

Remove an entity group from selection

public void DeselectEntity(EntityAttachmentItem rootEntity)

Parameters

rootEntity EntityAttachmentItem

FindRootForEntity(EntityAttachmentItem)

Get the root entity for a given entity (finds which root it belongs to)

public EntityAttachmentItem FindRootForEntity(EntityAttachmentItem entity)

Parameters

entity EntityAttachmentItem

Returns

EntityAttachmentItem

IsEntityInSelection(EntityAttachmentItem)

Check if an entity is already in selection

public bool IsEntityInSelection(EntityAttachmentItem entity)

Parameters

entity EntityAttachmentItem

Returns

bool

Save(string)

Save the blueprint with the given name

public bool Save(string blueprintName)

Parameters

blueprintName string

Returns

bool

True if saved successfully

SelectEntity(EntityAttachmentItem)

Add an entity and its connected group to selection

public void SelectEntity(EntityAttachmentItem entity)

Parameters

entity EntityAttachmentItem

ToggleEntitySelection(EntityAttachmentItem)

Toggle selection of an entity group

public void ToggleEntitySelection(EntityAttachmentItem entity)

Parameters

entity EntityAttachmentItem

Events

OnSelectionChanged

public event Action<int, int> OnSelectionChanged

Event Type

Action<int, int>