VRage.Game.ModAPI.IMyVoxelMaps Interface Reference

Inheritance diagram for VRage.Game.ModAPI.IMyVoxelMaps:

Public Member Functions
void	Clear ()
bool	Exist (IMyVoxelBase voxelMap)
IMyVoxelBase	GetOverlappingWithSphere (ref BoundingSphereD sphere)
IMyVoxelBase	GetVoxelMapWhoseBoundingBoxIntersectsBox (ref BoundingBoxD boundingBox, IMyVoxelBase ignoreVoxelMap)
void	GetAllOverlappingWithSphere (ref BoundingSphereD sphere, List< IMyVoxelBase > voxels)
	Gets a list of all voxelmaps that overlap the specified sphere. More...
List< IMyVoxelBase >	GetAllOverlappingWithSphere (ref BoundingSphereD sphere)
	Gets a list of all voxelmaps that overlap the specified sphere. More...
void	GetInstances (List< IMyVoxelBase > outInstances, Func< IMyVoxelBase, bool > collect=null)
IMyStorage	CreateStorage (Vector3I size)
IMyStorage	CreateStorage (byte[] data)
IMyVoxelMap	CreateVoxelMap (string storageName, IMyStorage storage, Vector3D position, long voxelMapId)
IMyVoxelMap	CreateVoxelMapFromStorageName (string storageName, string prefabVoxelMapName, Vector3D position)
	Adds a prefab voxel to the game world. More...
IMyVoxelShapeBox	GetBoxVoxelHand ()
IMyVoxelShapeCapsule	GetCapsuleVoxelHand ()
IMyVoxelShapeSphere	GetSphereVoxelHand ()
IMyVoxelShapeRamp	GetRampVoxelHand ()
void	PaintInShape (IMyVoxelBase voxelMap, IMyVoxelShape voxelShape, byte materialIdx)
	Will paint given material with given shape More...
void	CutOutShape (IMyVoxelBase voxelMap, IMyVoxelShape voxelShape)
	Will cut out given shape More...
void	FillInShape (IMyVoxelBase voxelMap, IMyVoxelShape voxelShape, byte materialIdx)
	Will fill given material with given shape More...
void	MakeCrater (IMyVoxelBase voxelMap, BoundingSphereD sphere, Vector3 normal, byte materialIdx)
	Creates a crater in a voxel, and deposits the specifid material. More...

Properties
int	VoxelMaterialCount [get]

Detailed Description

Definition at line 8 of file IMyVoxelMaps.cs.

Member Function Documentation

void VRage.Game.ModAPI.IMyVoxelMaps.Clear

(

)

Implemented in Sandbox.Game.Entities.MyVoxelMaps.

IMyStorage VRage.Game.ModAPI.IMyVoxelMaps.CreateStorage

(

Vector3I

size

)

IMyStorage VRage.Game.ModAPI.IMyVoxelMaps.CreateStorage

(

byte[]

data

)

IMyVoxelMap VRage.Game.ModAPI.IMyVoxelMaps.CreateVoxelMap	(	string	storageName,
		IMyStorage	storage,
		Vector3D	position,
		long	voxelMapId
	)

IMyVoxelMap VRage.Game.ModAPI.IMyVoxelMaps.CreateVoxelMapFromStorageName	(	string	storageName,
		string	prefabVoxelMapName,
		Vector3D	position
	)

Adds a prefab voxel to the game world.

Parameters

storageName	The name of which the voxel storage will be called within the world.
prefabVoxelMapName	The prefab voxel to add.
position	The Min corner position of the voxel within the world.

Returns

The newly added voxel map. Returns null if the prefabVoxelMapName does not exist.

void VRage.Game.ModAPI.IMyVoxelMaps.CutOutShape	(	IMyVoxelBase	voxelMap,
		IMyVoxelShape	voxelShape
	)

Will cut out given shape

Parameters

voxelMap
voxelShape

bool VRage.Game.ModAPI.IMyVoxelMaps.Exist

(

IMyVoxelBase

voxelMap

)

void VRage.Game.ModAPI.IMyVoxelMaps.FillInShape	(	IMyVoxelBase	voxelMap,
		IMyVoxelShape	voxelShape,
		byte	materialIdx
	)

Will fill given material with given shape

Parameters

voxelMap
voxelShape
materialIdx

void VRage.Game.ModAPI.IMyVoxelMaps.GetAllOverlappingWithSphere	(	ref BoundingSphereD	sphere,
		List< IMyVoxelBase >	voxels
	)

Gets a list of all voxelmaps that overlap the specified sphere.

Parameters

sphere

Returns

List<IMyVoxelBase> VRage.Game.ModAPI.IMyVoxelMaps.GetAllOverlappingWithSphere

(

ref BoundingSphereD

sphere

)

Gets a list of all voxelmaps that overlap the specified sphere.

Parameters

sphere

Returns

Not thread safe.

IMyVoxelShapeBox VRage.Game.ModAPI.IMyVoxelMaps.GetBoxVoxelHand

(

)

IMyVoxelShapeCapsule VRage.Game.ModAPI.IMyVoxelMaps.GetCapsuleVoxelHand

(

)

void VRage.Game.ModAPI.IMyVoxelMaps.GetInstances	(	List< IMyVoxelBase >	outInstances,
		Func< IMyVoxelBase, bool >	collect = null
	)

IMyVoxelBase VRage.Game.ModAPI.IMyVoxelMaps.GetOverlappingWithSphere

(

ref BoundingSphereD

sphere

)

Implemented in Sandbox.Game.Entities.MyVoxelMaps.

IMyVoxelShapeRamp VRage.Game.ModAPI.IMyVoxelMaps.GetRampVoxelHand

(

)

IMyVoxelShapeSphere VRage.Game.ModAPI.IMyVoxelMaps.GetSphereVoxelHand

(

)

IMyVoxelBase VRage.Game.ModAPI.IMyVoxelMaps.GetVoxelMapWhoseBoundingBoxIntersectsBox	(	ref BoundingBoxD	boundingBox,
		IMyVoxelBase	ignoreVoxelMap
	)

void VRage.Game.ModAPI.IMyVoxelMaps.MakeCrater	(	IMyVoxelBase	voxelMap,
		BoundingSphereD	sphere,
		Vector3	normal,
		byte	materialIdx
	)

Creates a crater in a voxel, and deposits the specifid material.

Parameters

voxelMap
sphere
normal
materialIdx

Not synced.
Call IMyVoxelBase.CreateMeteorCrater on the server instead for a synced operation.

void VRage.Game.ModAPI.IMyVoxelMaps.PaintInShape	(	IMyVoxelBase	voxelMap,
		IMyVoxelShape	voxelShape,
		byte	materialIdx
	)

Will paint given material with given shape

Parameters

voxelMap
voxelShape
materialIdx

Property Documentation

int VRage.Game.ModAPI.IMyVoxelMaps.VoxelMaterialCount

get

Definition at line 92 of file IMyVoxelMaps.cs.

---

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

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