Class MyEntitiesHelper_ModAPI

Inheritance

System.Object

MyEntitiesHelper_ModAPI

Implements

IMyEntities

Namespace: Sandbox.ModAPI

Assembly: Sandbox.Game.dll

Syntax

public class MyEntitiesHelper_ModAPI : Object, IMyEntities

Constructors

MyEntitiesHelper_ModAPI()

Declaration

public MyEntitiesHelper_ModAPI()

Explicit Interface Implementations

IMyEntities.AddEntity(IMyEntity, Boolean)

Declaration

void IMyEntities.AddEntity(IMyEntity entity, bool insertIntoScene)

Parameters

Type	Name	Description
IMyEntity	entity
System.Boolean	insertIntoScene

IMyEntities.CreateFromObjectBuilder(MyObjectBuilder_EntityBase)

Declaration

IMyEntity IMyEntities.CreateFromObjectBuilder(MyObjectBuilder_EntityBase objectBuilder)

Parameters

Type	Name	Description
MyObjectBuilder_EntityBase	objectBuilder

Returns

Type	Description
IMyEntity

IMyEntities.CreateFromObjectBuilderAndAdd(MyObjectBuilder_EntityBase)

Declaration

IMyEntity IMyEntities.CreateFromObjectBuilderAndAdd(MyObjectBuilder_EntityBase objectBuilder)

Parameters

Type	Name	Description
MyObjectBuilder_EntityBase	objectBuilder

Returns

Type	Description
IMyEntity

IMyEntities.CreateFromObjectBuilderNoinit(MyObjectBuilder_EntityBase)

Declaration

IMyEntity IMyEntities.CreateFromObjectBuilderNoinit(MyObjectBuilder_EntityBase objectBuilder)

Parameters

Type	Name	Description
MyObjectBuilder_EntityBase	objectBuilder

Returns

Type	Description
IMyEntity

IMyEntities.CreateFromObjectBuilderParallel(MyObjectBuilder_EntityBase, Boolean, Action<IMyEntity>)

Declaration

IMyEntity IMyEntities.CreateFromObjectBuilderParallel(MyObjectBuilder_EntityBase objectBuilder, bool addToScene, Action<IMyEntity> completionCallback)

Parameters

Type	Name	Description
MyObjectBuilder_EntityBase	objectBuilder
System.Boolean	addToScene
System.Action<IMyEntity>	completionCallback

Returns

Type	Description
IMyEntity

IMyEntities.EnableEntityBoundingBoxDraw(IMyEntity, Boolean, Nullable<Vector4>, Single, Nullable<Vector3>)

Declaration

void IMyEntities.EnableEntityBoundingBoxDraw(IMyEntity entity, bool enable, Nullable<Vector4> color, float lineWidth, Nullable<Vector3> inflateAmount)

Parameters

Type	Name	Description
IMyEntity	entity
System.Boolean	enable
System.Nullable<Vector4>	color
System.Single	lineWidth
System.Nullable<Vector3>	inflateAmount

IMyEntities.EntityExists(Int64)

Declaration

bool IMyEntities.EntityExists(long entityId)

Parameters

Type	Name	Description
System.Int64	entityId

Returns

Type	Description
System.Boolean

IMyEntities.EntityExists(Nullable<Int64>)

Declaration

bool IMyEntities.EntityExists(Nullable<long> entityId)

Parameters

Type	Name	Description
System.Nullable<System.Int64>	entityId

Returns

Type	Description
System.Boolean

IMyEntities.EntityExists(String)

Declaration

bool IMyEntities.EntityExists(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Boolean

IMyEntities.Exist(IMyEntity)

Declaration

bool IMyEntities.Exist(IMyEntity entity)

Parameters

Type	Name	Description
IMyEntity	entity

Returns

Type	Description
System.Boolean

IMyEntities.FindFreePlace(Vector3D, Single, Int32, Int32, Single)

Declaration

Nullable<Vector3D> IMyEntities.FindFreePlace(Vector3D basePos, float radius, int maxTestCount, int testsPerDistance, float stepSize)

Parameters

Type	Name	Description
Vector3D	basePos
System.Single	radius
System.Int32	maxTestCount
System.Int32	testsPerDistance
System.Single	stepSize

Returns

Type	Description
System.Nullable<Vector3D>

IMyEntities.GetElementsInBox(ref BoundingBoxD)

Declaration

List<IMyEntity> IMyEntities.GetElementsInBox(ref BoundingBoxD boundingBox)

Parameters

Type	Name	Description
BoundingBoxD	boundingBox

Returns

Type	Description
System.Collections.Generic.List<IMyEntity>

IMyEntities.GetEntities(HashSet<IMyEntity>, Func<IMyEntity, Boolean>)

Declaration

void IMyEntities.GetEntities(HashSet<IMyEntity> entities, Func<IMyEntity, bool> collect)

Parameters

Type	Name	Description
System.Collections.Generic.HashSet<IMyEntity>	entities
System.Func<IMyEntity, System.Boolean>	collect

IMyEntities.GetEntitiesInAABB(ref BoundingBoxD)

Declaration

List<IMyEntity> IMyEntities.GetEntitiesInAABB(ref BoundingBoxD boundingBox)

Parameters

Type	Name	Description
BoundingBoxD	boundingBox

Returns

Type	Description
System.Collections.Generic.List<IMyEntity>

IMyEntities.GetEntitiesInSphere(ref BoundingSphereD)

Declaration

List<IMyEntity> IMyEntities.GetEntitiesInSphere(ref BoundingSphereD boundingSphere)

Parameters

Type	Name	Description
BoundingSphereD	boundingSphere

Returns

Type	Description
System.Collections.Generic.List<IMyEntity>

IMyEntities.GetEntity(Func<IMyEntity, Boolean>)

Declaration

IMyEntity IMyEntities.GetEntity(Func<IMyEntity, bool> match)

Parameters

Type	Name	Description
System.Func<IMyEntity, System.Boolean>	match

Returns

Type	Description
IMyEntity

IMyEntities.GetEntityById(Int64)

Declaration

IMyEntity IMyEntities.GetEntityById(long entityId)

Parameters

Type	Name	Description
System.Int64	entityId

Returns

Type	Description
IMyEntity

IMyEntities.GetEntityById(Nullable<Int64>)

Declaration

IMyEntity IMyEntities.GetEntityById(Nullable<long> entityId)

Parameters

Type	Name	Description
System.Nullable<System.Int64>	entityId

Returns

Type	Description
IMyEntity

IMyEntities.GetEntityByName(String)

Declaration

IMyEntity IMyEntities.GetEntityByName(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
IMyEntity

IMyEntities.GetInflatedPlayerBoundingBox(ref BoundingBox, Single)

Declaration

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

Parameters

Type	Name	Description
BoundingBox	playerBox
System.Single	inflation

IMyEntities.GetInflatedPlayerBoundingBox(ref BoundingBoxD, Single)

Declaration

void IMyEntities.GetInflatedPlayerBoundingBox(ref BoundingBoxD playerBox, float inflation)

Parameters

Type	Name	Description
BoundingBoxD	playerBox
System.Single	inflation

IMyEntities.GetIntersectionWithSphere(ref BoundingSphereD)

Declaration

IMyEntity IMyEntities.GetIntersectionWithSphere(ref BoundingSphereD sphere)

Parameters

Type	Name	Description
BoundingSphereD	sphere

Returns

Type	Description
IMyEntity

IMyEntities.GetIntersectionWithSphere(ref BoundingSphereD, IMyEntity, IMyEntity)

Declaration

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

Parameters

Type	Name	Description
BoundingSphereD	sphere
IMyEntity	ignoreEntity0
IMyEntity	ignoreEntity1

Returns

Type	Description
IMyEntity

IMyEntities.GetIntersectionWithSphere(ref BoundingSphereD, IMyEntity, IMyEntity, Boolean, Boolean)

Declaration

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

Parameters

Type	Name	Description
BoundingSphereD	sphere
IMyEntity	ignoreEntity0
IMyEntity	ignoreEntity1
System.Boolean	ignoreVoxelMaps
System.Boolean	volumetricTest

Returns

Type	Description
System.Collections.Generic.List<IMyEntity>

IMyEntities.GetIntersectionWithSphere(ref BoundingSphereD, IMyEntity, IMyEntity, Boolean, Boolean, Boolean, Boolean, Boolean)

Declaration

IMyEntity IMyEntities.GetIntersectionWithSphere(ref BoundingSphereD sphere, IMyEntity ignoreEntity0, IMyEntity ignoreEntity1, bool ignoreVoxelMaps, bool volumetricTest, bool excludeEntitiesWithDisabledPhysics, bool ignoreFloatingObjects, bool ignoreHandWeapons)

Parameters

Type	Name	Description
BoundingSphereD	sphere
IMyEntity	ignoreEntity0
IMyEntity	ignoreEntity1
System.Boolean	ignoreVoxelMaps
System.Boolean	volumetricTest
System.Boolean	excludeEntitiesWithDisabledPhysics
System.Boolean	ignoreFloatingObjects
System.Boolean	ignoreHandWeapons

Returns

Type	Description
IMyEntity

IMyEntities.GetTopMostEntitiesInBox(ref BoundingBoxD)

Declaration

List<IMyEntity> IMyEntities.GetTopMostEntitiesInBox(ref BoundingBoxD boundingBox)

Parameters

Type	Name	Description
BoundingBoxD	boundingBox

Returns

Type	Description
System.Collections.Generic.List<IMyEntity>

IMyEntities.GetTopMostEntitiesInSphere(ref BoundingSphereD)

Declaration

List<IMyEntity> IMyEntities.GetTopMostEntitiesInSphere(ref BoundingSphereD boundingSphere)

Parameters

Type	Name	Description
BoundingSphereD	boundingSphere

Returns

Type	Description
System.Collections.Generic.List<IMyEntity>

IMyEntities.IsInsideVoxel(Vector3, Vector3, out Vector3)

Declaration

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

Parameters

Type	Name	Description
Vector3	pos
Vector3	hintPosition
Vector3	lastOutsidePos

Returns

Type	Description
System.Boolean

IMyEntities.IsInsideVoxel(Vector3D, Vector3D, out Vector3D)

Declaration

bool IMyEntities.IsInsideVoxel(Vector3D pos, Vector3D hintPosition, out Vector3D lastOutsidePos)

Parameters

Type	Name	Description
Vector3D	pos
Vector3D	hintPosition
Vector3D	lastOutsidePos

Returns

Type	Description
System.Boolean

IMyEntities.IsInsideWorld(Vector3D)

Declaration

bool IMyEntities.IsInsideWorld(Vector3D pos)

Parameters

Type	Name	Description
Vector3D	pos

Returns

Type	Description
System.Boolean

IMyEntities.IsNameExists(IMyEntity, String)

Declaration

bool IMyEntities.IsNameExists(IMyEntity entity, string name)

Parameters

Type	Name	Description
IMyEntity	entity
System.String	name

Returns

Type	Description
System.Boolean

IMyEntities.IsRaycastBlocked(Vector3D, Vector3D)

Declaration

bool IMyEntities.IsRaycastBlocked(Vector3D pos, Vector3D target)

Parameters

Type	Name	Description
Vector3D	pos
Vector3D	target

Returns

Type	Description
System.Boolean

IMyEntities.IsSpherePenetrating(ref BoundingSphereD)

Declaration

bool IMyEntities.IsSpherePenetrating(ref BoundingSphereD bs)

Parameters

Type	Name	Description
BoundingSphereD	bs

Returns

Type	Description
System.Boolean

IMyEntities.IsTypeHidden(Type)

Declaration

bool IMyEntities.IsTypeHidden(Type type)

Parameters

Type	Name	Description
System.Type	type

Returns

Type	Description
System.Boolean

IMyEntities.IsVisible(IMyEntity)

Declaration

bool IMyEntities.IsVisible(IMyEntity entity)

Parameters

Type	Name	Description
IMyEntity	entity

Returns

Type	Description
System.Boolean

IMyEntities.IsWorldLimited()

Declaration

bool IMyEntities.IsWorldLimited()

Returns

Type	Description
System.Boolean

IMyEntities.MarkForClose(IMyEntity)

Declaration

void IMyEntities.MarkForClose(IMyEntity entity)

Parameters

Type	Name	Description
IMyEntity	entity

IMyEntities.OnCloseAll

Declaration

event Action IMyEntities.OnCloseAll

Returns

Type	Description
System.Action

IMyEntities.OnEntityAdd

Declaration

event Action<IMyEntity> IMyEntities.OnEntityAdd

Returns

Type	Description
System.Action<IMyEntity>

IMyEntities.OnEntityNameSet

Declaration

event Action<IMyEntity, string, string> IMyEntities.OnEntityNameSet

Returns

Type	Description
System.Action<IMyEntity, System.String, System.String>

IMyEntities.OnEntityRemove

Declaration

event Action<IMyEntity> IMyEntities.OnEntityRemove

Returns

Type	Description
System.Action<IMyEntity>

IMyEntities.RegisterForDraw(IMyEntity)

Declaration

void IMyEntities.RegisterForDraw(IMyEntity entity)

Parameters

Type	Name	Description
IMyEntity	entity

IMyEntities.RegisterForUpdate(IMyEntity)

Declaration

void IMyEntities.RegisterForUpdate(IMyEntity entity)

Parameters

Type	Name	Description
IMyEntity	entity

IMyEntities.RemapObjectBuilder(MyObjectBuilder_EntityBase)

Declaration

void IMyEntities.RemapObjectBuilder(MyObjectBuilder_EntityBase objectBuilder)

Parameters

Type	Name	Description
MyObjectBuilder_EntityBase	objectBuilder

IMyEntities.RemapObjectBuilderCollection(IEnumerable<MyObjectBuilder_EntityBase>)

Declaration

void IMyEntities.RemapObjectBuilderCollection(IEnumerable<MyObjectBuilder_EntityBase> objectBuilders)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<MyObjectBuilder_EntityBase>	objectBuilders

IMyEntities.RemoveEntity(IMyEntity)

Declaration

void IMyEntities.RemoveEntity(IMyEntity entity)

Parameters

Type	Name	Description
IMyEntity	entity

IMyEntities.RemoveFromClosedEntities(IMyEntity)

Declaration

void IMyEntities.RemoveFromClosedEntities(IMyEntity entity)

Parameters

Type	Name	Description
IMyEntity	entity

IMyEntities.RemoveName(IMyEntity)

Declaration

void IMyEntities.RemoveName(IMyEntity entity)

Parameters

Type	Name	Description
IMyEntity	entity

IMyEntities.SetEntityName(IMyEntity, Boolean)

Declaration

void IMyEntities.SetEntityName(IMyEntity entity, bool possibleRename)

Parameters

Type	Name	Description
IMyEntity	entity
System.Boolean	possibleRename

IMyEntities.SetTypeHidden(Type, Boolean)

Declaration

void IMyEntities.SetTypeHidden(Type type, bool hidden)

Parameters

Type	Name	Description
System.Type	type
System.Boolean	hidden

IMyEntities.TryGetEntityById(Int64, out IMyEntity)

Declaration

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

Parameters

Type	Name	Description
System.Int64	id
IMyEntity	entity

Returns

Type	Description
System.Boolean

IMyEntities.TryGetEntityById(Nullable<Int64>, out IMyEntity)

Declaration

bool IMyEntities.TryGetEntityById(Nullable<long> id, out IMyEntity entity)

Parameters

Type	Name	Description
System.Nullable<System.Int64>	id
IMyEntity	entity

Returns

Type	Description
System.Boolean

IMyEntities.TryGetEntityByName(String, out IMyEntity)

Declaration

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

Parameters

Type	Name	Description
System.String	name
IMyEntity	entity

Returns

Type	Description
System.Boolean

IMyEntities.UnhideAllTypes()

Declaration

void IMyEntities.UnhideAllTypes()

IMyEntities.UnregisterForDraw(IMyEntity)

Declaration

void IMyEntities.UnregisterForDraw(IMyEntity entity)

Parameters

Type	Name	Description
IMyEntity	entity

IMyEntities.UnregisterForUpdate(IMyEntity, Boolean)

Declaration

void IMyEntities.UnregisterForUpdate(IMyEntity entity, bool immediate)

Parameters

Type	Name	Description
IMyEntity	entity
System.Boolean	immediate

IMyEntities.WorldHalfExtent()

Declaration

float IMyEntities.WorldHalfExtent()

Returns

Type	Description
System.Single

IMyEntities.WorldSafeHalfExtent()

Declaration

float IMyEntities.WorldSafeHalfExtent()

Returns

Type	Description
System.Single

Implements

IMyEntities