VRage.Game.Entity.UseObject.IMyUseObject Interface Reference

Inheritance diagram for VRage.Game.Entity.UseObject.IMyUseObject:

Public Member Functions
void	Use (UseActionEnum actionEnum, IMyEntity user)
	Uses object by specified action Caller calls this method only on supported actions More...
MyActionDescription	GetActionInfo (UseActionEnum actionEnum)
	Gets action text Caller calls this method only on supported actions More...
bool	HandleInput ()
void	OnSelectionLost ()
void	SetRenderID (uint id)
void	SetInstanceID (int id)

Properties
IMyEntity	Owner [get]
MyModelDummy	Dummy [get]
float	InteractiveDistance [get]
	Consider object as being in interactive range only if distance from character is smaller or equal to this value More...
MatrixD	ActivationMatrix [get]
	Matrix of object, scale represents size of object More...
MatrixD	WorldMatrix [get]
	Matrix of object, scale represents size of object More...
int	RenderObjectID [get]
	Render ID of objects More...
int	InstanceID [get]
	Instance ID of objects (this should mostly be unused More...
bool	ShowOverlay [get]
	Show overlay (semitransparent bounding box) More...
UseActionEnum	SupportedActions [get]
	Returns supported actions More...
bool	ContinuousUsage [get]
	When true, use will be called every frame More...
bool	PlayIndicatorSound [get]

Detailed Description

Definition at line 41 of file IMyUseObject.cs.

Member Function Documentation

MyActionDescription VRage.Game.Entity.UseObject.IMyUseObject.GetActionInfo

(

UseActionEnum

actionEnum

)

Gets action text Caller calls this method only on supported actions

Implemented in Sandbox.Game.Entities.MyAreaMarker, SpaceEngineers.Game.Entities.Cube.MyUseObjectPanelButton, Sandbox.Game.Entities.Cube.MyUseObjectPanelButton, SpaceEngineers.Game.Entities.UseObjects.MyUseObjectInventory, SpaceEngineers.Game.Entities.UseObjects.MyUseObjectWardrobe, Sandbox.Game.Entities.Cube.MyUseObjectAdvancedDoorTerminal, Sandbox.Game.Entities.Cube.MyUseObjectAirtightDoors, Sandbox.Game.Entities.Cube.MyUseObjectDoorTerminal, Sandbox.Game.Entities.Cube.MyUseObjectTerminal, Sandbox.Game.Entities.Cube.MyUseObjectTextPanel, Sandbox.Game.Entities.Cube.MyUseObjectCockpitDoor, SpaceEngineers.Game.Entities.UseObjects.MyUseObjectMedicalRoom, Sandbox.Game.Entities.Cube.MyUseObjectCryoChamberDoor, and VRage.Game.Entity.UseObject.MyUseObjectBase.

bool VRage.Game.Entity.UseObject.IMyUseObject.HandleInput

(

)

Implemented in Sandbox.Game.Entities.MyAreaMarker, SpaceEngineers.Game.Entities.Cube.MyUseObjectPanelButton, Sandbox.Game.Entities.Cube.MyUseObjectPanelButton, Sandbox.Game.Entities.Cube.MyUseObjectAdvancedDoorTerminal, Sandbox.Game.Entities.Cube.MyUseObjectAirtightDoors, Sandbox.Game.Entities.Cube.MyUseObjectDoorTerminal, SpaceEngineers.Game.Entities.UseObjects.MyUseObjectInventory, SpaceEngineers.Game.Entities.UseObjects.MyUseObjectWardrobe, Sandbox.Game.Entities.Cube.MyUseObjectTextPanel, SpaceEngineers.Game.Entities.UseObjects.MyUseObjectMedicalRoom, Sandbox.Game.Entities.Cube.MyUseObjectTerminal, Sandbox.Game.Entities.Cube.MyUseObjectCockpitDoor, Sandbox.Game.Entities.Cube.MyUseObjectCryoChamberDoor, and VRage.Game.Entity.UseObject.MyUseObjectBase.

void VRage.Game.Entity.UseObject.IMyUseObject.OnSelectionLost

(

)

Implemented in Sandbox.Game.Entities.MyAreaMarker, SpaceEngineers.Game.Entities.Cube.MyUseObjectPanelButton, Sandbox.Game.Entities.Cube.MyUseObjectPanelButton, Sandbox.Game.Entities.Cube.MyUseObjectAdvancedDoorTerminal, Sandbox.Game.Entities.Cube.MyUseObjectAirtightDoors, Sandbox.Game.Entities.Cube.MyUseObjectDoorTerminal, SpaceEngineers.Game.Entities.UseObjects.MyUseObjectInventory, SpaceEngineers.Game.Entities.UseObjects.MyUseObjectWardrobe, Sandbox.Game.Entities.Cube.MyUseObjectTextPanel, SpaceEngineers.Game.Entities.UseObjects.MyUseObjectMedicalRoom, Sandbox.Game.Entities.Cube.MyUseObjectTerminal, Sandbox.Game.Entities.Cube.MyUseObjectCockpitDoor, Sandbox.Game.Entities.Cube.MyUseObjectCryoChamberDoor, and VRage.Game.Entity.UseObject.MyUseObjectBase.

void VRage.Game.Entity.UseObject.IMyUseObject.SetInstanceID

(

int

id

)

Implemented in Sandbox.Game.Entities.MyAreaMarker, and VRage.Game.Entity.UseObject.MyUseObjectBase.

void VRage.Game.Entity.UseObject.IMyUseObject.SetRenderID

(

uint

id

)

Implemented in Sandbox.Game.Entities.MyAreaMarker, and VRage.Game.Entity.UseObject.MyUseObjectBase.

void VRage.Game.Entity.UseObject.IMyUseObject.Use	(	UseActionEnum	actionEnum,
		IMyEntity	user
	)

Uses object by specified action Caller calls this method only on supported actions

Implemented in Sandbox.Game.Entities.MyAreaMarker, SpaceEngineers.Game.Entities.Cube.MyUseObjectPanelButton, Sandbox.Game.Entities.Cube.MyUseObjectPanelButton, Sandbox.Game.Entities.Cube.MyUseObjectTextPanel, SpaceEngineers.Game.Entities.UseObjects.MyUseObjectMedicalRoom, SpaceEngineers.Game.Entities.UseObjects.MyUseObjectInventory, Sandbox.Game.Entities.Cube.MyUseObjectAdvancedDoorTerminal, Sandbox.Game.Entities.Cube.MyUseObjectAirtightDoors, Sandbox.Game.Entities.Cube.MyUseObjectDoorTerminal, Sandbox.Game.Entities.Cube.MyUseObjectTerminal, SpaceEngineers.Game.Entities.UseObjects.MyUseObjectWardrobe, Sandbox.Game.Entities.Cube.MyUseObjectCryoChamberDoor, VRage.Game.Entity.UseObject.MyUseObjectBase, and Sandbox.Game.Entities.Cube.MyUseObjectCockpitDoor.

Property Documentation

MatrixD VRage.Game.Entity.UseObject.IMyUseObject.ActivationMatrix

get

Matrix of object, scale represents size of object

Definition at line 55 of file IMyUseObject.cs.

bool VRage.Game.Entity.UseObject.IMyUseObject.ContinuousUsage

get

When true, use will be called every frame

Definition at line 85 of file IMyUseObject.cs.

MyModelDummy VRage.Game.Entity.UseObject.IMyUseObject.Dummy

get

Definition at line 45 of file IMyUseObject.cs.

int VRage.Game.Entity.UseObject.IMyUseObject.InstanceID

get

Instance ID of objects (this should mostly be unused

Definition at line 70 of file IMyUseObject.cs.

float VRage.Game.Entity.UseObject.IMyUseObject.InteractiveDistance

get

Consider object as being in interactive range only if distance from character is smaller or equal to this value

Definition at line 50 of file IMyUseObject.cs.

IMyEntity VRage.Game.Entity.UseObject.IMyUseObject.Owner

get

Definition at line 43 of file IMyUseObject.cs.

bool VRage.Game.Entity.UseObject.IMyUseObject.PlayIndicatorSound

get

Definition at line 107 of file IMyUseObject.cs.

int VRage.Game.Entity.UseObject.IMyUseObject.RenderObjectID

get

Render ID of objects

Definition at line 65 of file IMyUseObject.cs.

bool VRage.Game.Entity.UseObject.IMyUseObject.ShowOverlay

get

Show overlay (semitransparent bounding box)

Definition at line 75 of file IMyUseObject.cs.

UseActionEnum VRage.Game.Entity.UseObject.IMyUseObject.SupportedActions

get

Returns supported actions

Definition at line 80 of file IMyUseObject.cs.

MatrixD VRage.Game.Entity.UseObject.IMyUseObject.WorldMatrix

get

Matrix of object, scale represents size of object

Definition at line 60 of file IMyUseObject.cs.

---

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

• Sources/VRage.Game/Entity/UseObject/IMyUseObject.cs