VRage.ModAPI.IMyEntities Interface Reference

Inheritance diagram for VRage.ModAPI.IMyEntities:

Public Member Functions
bool	TryGetEntityById (long id, out IMyEntity entity)
bool	TryGetEntityById (long?id, out IMyEntity entity)
bool	TryGetEntityByName (string name, out IMyEntity entity)
bool	EntityExists (string name)
void	AddEntity (IMyEntity entity, bool insertIntoScene=true)
IMyEntity	CreateFromObjectBuilder (MyObjectBuilder_EntityBase objectBuilder)
IMyEntity	CreateFromObjectBuilderAndAdd (MyObjectBuilder_EntityBase objectBuilder)
void	RemoveEntity (IMyEntity entity)
bool	IsSpherePenetrating (ref BoundingSphereD bs)
Vector3D	FindFreePlace (Vector3D basePos, float radius, int maxTestCount=20, int testsPerDistance=5, float stepSize=1)
void	GetInflatedPlayerBoundingBox (ref BoundingBox playerBox, float inflation)
bool	IsInsideVoxel (Vector3 pos, Vector3 hintPosition, out Vector3 lastOutsidePos)
bool	IsWorldLimited ()
float	WorldHalfExtent ()
float	WorldSafeHalfExtent ()
bool	IsInsideWorld (Vector3D pos)
bool	IsRaycastBlocked (Vector3D pos, Vector3D target)
void	SetEntityName (IMyEntity IMyEntity, bool possibleRename=true)
bool	IsNameExists (IMyEntity entity, string name)
void	RemoveFromClosedEntities (IMyEntity entity)
void	RemoveName (IMyEntity entity)
bool	Exist (IMyEntity entity)
void	MarkForClose (IMyEntity entity)
void	RegisterForUpdate (IMyEntity entity)
void	RegisterForDraw (IMyEntity entity)
void	UnregisterForUpdate (IMyEntity entity, bool immediate=false)
void	UnregisterForDraw (IMyEntity entity)
IMyEntity	GetIntersectionWithSphere (ref BoundingSphereD sphere)
IMyEntity	GetIntersectionWithSphere (ref BoundingSphereD sphere, IMyEntity ignoreEntity0, IMyEntity ignoreEntity1)
IMyEntity	GetIntersectionWithSphere (ref BoundingSphereD sphere, IMyEntity ignoreEntity0, IMyEntity ignoreEntity1, bool ignoreVoxelMaps, bool volumetricTest, bool excludeEntitiesWithDisabledPhysics=false, bool ignoreFloatingObjects=true, bool ignoreHandWeapons=true)
IMyEntity	GetEntityById (long entityId)
IMyEntity	GetEntityById (long?entityId)
bool	EntityExists (long entityId)
bool	EntityExists (long?entityId)
IMyEntity	GetEntityByName (string name)
void	SetTypeHidden (Type type, bool hidden)
bool	IsTypeHidden (Type type)
bool	IsVisible (IMyEntity entity)
void	UnhideAllTypes ()
void	RemapObjectBuilderCollection (IEnumerable< MyObjectBuilder_EntityBase > objectBuilders)
void	RemapObjectBuilder (MyObjectBuilder_EntityBase objectBuilder)
IMyEntity	CreateFromObjectBuilderNoinit (MyObjectBuilder_EntityBase objectBuilder)
void	EnableEntityBoundingBoxDraw (IMyEntity entity, bool enable, Vector4?color=null, float lineWidth=0.01f, Vector3?inflateAmount=null)
IMyEntity	GetEntity (Func< IMyEntity, bool > match)
void	GetEntities (HashSet< IMyEntity > entities, Func< IMyEntity, bool > collect=null)
List< IMyEntity >	GetIntersectionWithSphere (ref BoundingSphereD sphere, IMyEntity ignoreEntity0, IMyEntity ignoreEntity1, bool ignoreVoxelMaps, bool volumetricTest)
List< IMyEntity >	GetEntitiesInAABB (ref BoundingBoxD boundingBox)
List< IMyEntity >	GetEntitiesInSphere (ref BoundingSphereD boundingSphere)
List< IMyEntity >	GetElementsInBox (ref BoundingBoxD boundingBox)
List< IMyEntity >	GetTopMostEntitiesInSphere (ref BoundingSphereD boundingSphere)
List< IMyEntity >	GetTopMostEntitiesInBox (ref BoundingBoxD boundingBox)

Events
Action< IMyEntity >	OnEntityRemove
Action< IMyEntity >	OnEntityAdd
Action	OnCloseAll
Action< IMyEntity, string, string >	OnEntityNameSet

Detailed Description

Definition at line 8 of file IMyEntities.cs.

Member Function Documentation

void VRage.ModAPI.IMyEntities.AddEntity	(	IMyEntity	entity,
		bool	insertIntoScene = true
	)

IMyEntity VRage.ModAPI.IMyEntities.CreateFromObjectBuilder

(

MyObjectBuilder_EntityBase

objectBuilder

)

IMyEntity VRage.ModAPI.IMyEntities.CreateFromObjectBuilderAndAdd

(

MyObjectBuilder_EntityBase

objectBuilder

)

IMyEntity VRage.ModAPI.IMyEntities.CreateFromObjectBuilderNoinit

(

MyObjectBuilder_EntityBase

objectBuilder

)

void VRage.ModAPI.IMyEntities.EnableEntityBoundingBoxDraw	(	IMyEntity	entity,
		bool	enable,
		Vector4?	color = null,
		float	lineWidth = 0.01f,
		Vector3?	inflateAmount = null
	)

bool VRage.ModAPI.IMyEntities.EntityExists

(

string

name

)

bool VRage.ModAPI.IMyEntities.EntityExists

(

long

entityId

)

bool VRage.ModAPI.IMyEntities.EntityExists

(

long?

entityId

)

bool VRage.ModAPI.IMyEntities.Exist

(

IMyEntity

entity

)

Vector3D VRage.ModAPI.IMyEntities.FindFreePlace	(	Vector3D	basePos,
		float	radius,
		int	maxTestCount = 20,
		int	testsPerDistance = 5,
		float	stepSize = 1
	)

List<IMyEntity> VRage.ModAPI.IMyEntities.GetElementsInBox

(

ref BoundingBoxD

boundingBox

)

void VRage.ModAPI.IMyEntities.GetEntities	(	HashSet< IMyEntity >	entities,
		Func< IMyEntity, bool >	collect = null
	)

List<IMyEntity> VRage.ModAPI.IMyEntities.GetEntitiesInAABB

(

ref BoundingBoxD

boundingBox

)

List<IMyEntity> VRage.ModAPI.IMyEntities.GetEntitiesInSphere

(

ref BoundingSphereD

boundingSphere

)

IMyEntity VRage.ModAPI.IMyEntities.GetEntity

(

Func< IMyEntity, bool >

match

)

IMyEntity VRage.ModAPI.IMyEntities.GetEntityById

(

long

entityId

)

IMyEntity VRage.ModAPI.IMyEntities.GetEntityById

(

long?

entityId

)

IMyEntity VRage.ModAPI.IMyEntities.GetEntityByName

(

string

name

)

void VRage.ModAPI.IMyEntities.GetInflatedPlayerBoundingBox	(	ref BoundingBox	playerBox,
		float	inflation
	)

IMyEntity VRage.ModAPI.IMyEntities.GetIntersectionWithSphere

(

ref BoundingSphereD

sphere

)

IMyEntity VRage.ModAPI.IMyEntities.GetIntersectionWithSphere	(	ref BoundingSphereD	sphere,
		IMyEntity	ignoreEntity0,
		IMyEntity	ignoreEntity1
	)

IMyEntity VRage.ModAPI.IMyEntities.GetIntersectionWithSphere	(	ref BoundingSphereD	sphere,
		IMyEntity	ignoreEntity0,
		IMyEntity	ignoreEntity1,
		bool	ignoreVoxelMaps,
		bool	volumetricTest,
		bool	excludeEntitiesWithDisabledPhysics = false,
		bool	ignoreFloatingObjects = true,
		bool	ignoreHandWeapons = true
	)

List<IMyEntity> VRage.ModAPI.IMyEntities.GetIntersectionWithSphere	(	ref BoundingSphereD	sphere,
		IMyEntity	ignoreEntity0,
		IMyEntity	ignoreEntity1,
		bool	ignoreVoxelMaps,
		bool	volumetricTest
	)

List<IMyEntity> VRage.ModAPI.IMyEntities.GetTopMostEntitiesInBox

(

ref BoundingBoxD

boundingBox

)

List<IMyEntity> VRage.ModAPI.IMyEntities.GetTopMostEntitiesInSphere

(

ref BoundingSphereD

boundingSphere

)

bool VRage.ModAPI.IMyEntities.IsInsideVoxel	(	Vector3	pos,
		Vector3	hintPosition,
		out Vector3	lastOutsidePos
	)

bool VRage.ModAPI.IMyEntities.IsInsideWorld

(

Vector3D

pos

)

bool VRage.ModAPI.IMyEntities.IsNameExists	(	IMyEntity	entity,
		string	name
	)

bool VRage.ModAPI.IMyEntities.IsRaycastBlocked	(	Vector3D	pos,
		Vector3D	target
	)

bool VRage.ModAPI.IMyEntities.IsSpherePenetrating

(

ref BoundingSphereD

bs

)

bool VRage.ModAPI.IMyEntities.IsTypeHidden

(

Type

type

)

bool VRage.ModAPI.IMyEntities.IsVisible

(

IMyEntity

entity

)

bool VRage.ModAPI.IMyEntities.IsWorldLimited

(

)

void VRage.ModAPI.IMyEntities.MarkForClose

(

IMyEntity

entity

)

void VRage.ModAPI.IMyEntities.RegisterForDraw

(

IMyEntity

entity

)

void VRage.ModAPI.IMyEntities.RegisterForUpdate

(

IMyEntity

entity

)

void VRage.ModAPI.IMyEntities.RemapObjectBuilder

(

MyObjectBuilder_EntityBase

objectBuilder

)

void VRage.ModAPI.IMyEntities.RemapObjectBuilderCollection

(

IEnumerable< MyObjectBuilder_EntityBase >

objectBuilders

)

void VRage.ModAPI.IMyEntities.RemoveEntity

(

IMyEntity

entity

)

void VRage.ModAPI.IMyEntities.RemoveFromClosedEntities

(

IMyEntity

entity

)

void VRage.ModAPI.IMyEntities.RemoveName

(

IMyEntity

entity

)

void VRage.ModAPI.IMyEntities.SetEntityName	(	IMyEntity	IMyEntity,
		bool	possibleRename = true
	)

void VRage.ModAPI.IMyEntities.SetTypeHidden	(	Type	type,
		bool	hidden
	)

bool VRage.ModAPI.IMyEntities.TryGetEntityById	(	long	id,
		out IMyEntity	entity
	)

bool VRage.ModAPI.IMyEntities.TryGetEntityById	(	long?	id,
		out IMyEntity	entity
	)

bool VRage.ModAPI.IMyEntities.TryGetEntityByName	(	string	name,
		out IMyEntity	entity
	)

void VRage.ModAPI.IMyEntities.UnhideAllTypes

(

)

void VRage.ModAPI.IMyEntities.UnregisterForDraw

(

IMyEntity

entity

)

void VRage.ModAPI.IMyEntities.UnregisterForUpdate	(	IMyEntity	entity,
		bool	immediate = false
	)

float VRage.ModAPI.IMyEntities.WorldHalfExtent

(

)

float VRage.ModAPI.IMyEntities.WorldSafeHalfExtent

(

)

Event Documentation

Action VRage.ModAPI.IMyEntities.OnCloseAll

Definition at line 21 of file IMyEntities.cs.

Action<IMyEntity> VRage.ModAPI.IMyEntities.OnEntityAdd

Definition at line 20 of file IMyEntities.cs.

Action<IMyEntity, string, string> VRage.ModAPI.IMyEntities.OnEntityNameSet

Definition at line 22 of file IMyEntities.cs.

Action<IMyEntity> VRage.ModAPI.IMyEntities.OnEntityRemove

Definition at line 19 of file IMyEntities.cs.

---

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

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