VRage.Game.ModAPI.IMyCubeBuilder Interface Reference

Inheritance diagram for VRage.Game.ModAPI.IMyCubeBuilder:

Public Member Functions
void	Activate (MyDefinitionId?blockDefinitionId=null)
	Activates the building mode More...
bool	AddConstruction (IMyEntity buildingEntity)
	Adds construction site of block with currently selected definition More...
void	Deactivate ()
	Deactivates all modes More...
void	DeactivateBlockCreation ()
	Deactivates building mode More...
void	StartNewGridPlacement (MyCubeSize cubeSize, bool isStatic)
	Creates new grid More...
IMyCubeGrid	FindClosestGrid ()
	Finds grid to build on More...

Properties
bool	BlockCreationIsActivated [get]
bool	FreezeGizmo [get, set]
	Freezes the built object preview in current position More...
bool	ShowRemoveGizmo [get, set]
	Shows the delete area preview More...
bool	UseSymmetry [get, set]
	Enables synmetry block placing More...
bool	UseTransparency [get, set]
bool	IsActivated [get]
	Is any mode active More...

Detailed Description

Definition at line 5 of file IMyCubeBuilder.cs.

Member Function Documentation

void VRage.Game.ModAPI.IMyCubeBuilder.Activate

(

MyDefinitionId?

blockDefinitionId = null

)

Activates the building mode

Implemented in Sandbox.Game.Entities.MyCubeBuilder.

bool VRage.Game.ModAPI.IMyCubeBuilder.AddConstruction

(

IMyEntity

buildingEntity

)

Adds construction site of block with currently selected definition

Parameters

buildingEntity

summary> Returns state of building mode /summary>

void VRage.Game.ModAPI.IMyCubeBuilder.Deactivate

(

)

Deactivates all modes

Implemented in Sandbox.Game.Entities.MyCubeBuilder.

void VRage.Game.ModAPI.IMyCubeBuilder.DeactivateBlockCreation

(

)

Deactivates building mode

Implemented in Sandbox.Game.Entities.MyCubeBuilder.

IMyCubeGrid VRage.Game.ModAPI.IMyCubeBuilder.FindClosestGrid

(

)

Finds grid to build on

Returns

found grid

void VRage.Game.ModAPI.IMyCubeBuilder.StartNewGridPlacement	(	MyCubeSize	cubeSize,
		bool	isStatic
	)

Creates new grid

Parameters

cubeSize	Grid size
isStatic	Station = static

Property Documentation

bool VRage.Game.ModAPI.IMyCubeBuilder.BlockCreationIsActivated

get

Definition at line 21 of file IMyCubeBuilder.cs.

bool VRage.Game.ModAPI.IMyCubeBuilder.FreezeGizmo

getset

Freezes the built object preview in current position

Definition at line 36 of file IMyCubeBuilder.cs.

bool VRage.Game.ModAPI.IMyCubeBuilder.IsActivated

get

Is any mode active

Definition at line 69 of file IMyCubeBuilder.cs.

bool VRage.Game.ModAPI.IMyCubeBuilder.ShowRemoveGizmo

getset

Shows the delete area preview

Definition at line 41 of file IMyCubeBuilder.cs.

bool VRage.Game.ModAPI.IMyCubeBuilder.UseSymmetry

getset

Enables synmetry block placing

Definition at line 53 of file IMyCubeBuilder.cs.

bool VRage.Game.ModAPI.IMyCubeBuilder.UseTransparency

getset

Definition at line 58 of file IMyCubeBuilder.cs.

---

The documentation for this interface was generated from the following file:

• Sources/VRage.Game/ModAPI/IMyCubeBuilder.cs