Interface IMyCubeBuilder

Describes hand, than holding block (mods interface)

Namespace: VRage.Game.ModAPI

Assembly: VRage.Game.dll

Syntax

public interface IMyCubeBuilder

Properties

BlockCreationIsActivated

Returns state of building mode

Declaration

bool BlockCreationIsActivated { get; }

Property Value

Type	Description
System.Boolean

FreezeGizmo

Freezes the built object preview in current position

Declaration

bool FreezeGizmo { get; set; }

Property Value

Type	Description
System.Boolean

IsActivated

Gets whether there block creation is activated

Declaration

bool IsActivated { get; }

Property Value

Type	Description
System.Boolean

ShowRemoveGizmo

Shows the delete area preview

Declaration

bool ShowRemoveGizmo { get; set; }

Property Value

Type	Description
System.Boolean

UseSymmetry

Enables symmetry block placing

Declaration

bool UseSymmetry { get; set; }

Property Value

Type	Description
System.Boolean

UseTransparency

Gets or sets whether projected block should be 25% transparent

Declaration

bool UseTransparency { get; set; }

Property Value

Type	Description
System.Boolean

Methods

Activate(Nullable<MyDefinitionId>)

Activates the building mode

Declaration

void Activate(Nullable<MyDefinitionId> blockDefinitionId = null)

Parameters

Type	Name	Description
System.Nullable<MyDefinitionId>	blockDefinitionId

AddConstruction(IMyEntity)

Declaration

bool AddConstruction(IMyEntity buildingEntity)

Parameters

Type	Name	Description
IMyEntity	buildingEntity

Returns

Type	Description
System.Boolean

Deactivate()

Deactivates all modes

Declaration

void Deactivate()

DeactivateBlockCreation()

Deactivates building mode

Declaration

void DeactivateBlockCreation()

FindClosestGrid()

Finds grid to build on

Declaration

IMyCubeGrid FindClosestGrid()

Returns

Type	Description
IMyCubeGrid	Found grid

StartNewGridPlacement(MyCubeSize, Boolean)

Calls Activate(Nullable<MyDefinitionId>) with LargeBlockArmorBlock definition and forces local player stop using weapon or tool

Declaration

void StartNewGridPlacement(MyCubeSize cubeSize, bool isStatic)

Parameters

Type	Name	Description
MyCubeSize	cubeSize	Ignored
System.Boolean	isStatic	Ignored