VRage.Game.Entity.UseObject.MyUseObjectBase Class Reference

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

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

Properties
IMyEntity	Owner [get]
MyModelDummy	Dummy [get]
abstract float	InteractiveDistance [get]
abstract MatrixD	ActivationMatrix [get]
abstract MatrixD	WorldMatrix [get]
abstract int	RenderObjectID [get]
virtual int	InstanceID [get]
abstract bool	ShowOverlay [get]
abstract UseActionEnum	SupportedActions [get]
abstract bool	ContinuousUsage [get]
abstract bool	PlayIndicatorSound [get]
Properties inherited from VRage.Game.Entity.UseObject.IMyUseObject
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 8 of file MyUseObjectBase.cs.

Constructor & Destructor Documentation

VRage.Game.Entity.UseObject.MyUseObjectBase.MyUseObjectBase ( IMyEntity  owner, MyModelDummy  dummy  )

inline

Definition at line 10 of file MyUseObjectBase.cs.

Member Function Documentation

abstract MyActionDescription VRage.Game.Entity.UseObject.MyUseObjectBase.GetActionInfo ( UseActionEnum  actionEnum )

pure virtual

Gets action text Caller calls this method only on supported actions

Implements VRage.Game.Entity.UseObject.IMyUseObject.

Implemented in 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, and Sandbox.Game.Entities.Cube.MyUseObjectCryoChamberDoor.

abstract bool VRage.Game.Entity.UseObject.MyUseObjectBase.HandleInput ( )

pure virtual

Implements VRage.Game.Entity.UseObject.IMyUseObject.

Implemented in 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, and Sandbox.Game.Entities.Cube.MyUseObjectCryoChamberDoor.

abstract void VRage.Game.Entity.UseObject.MyUseObjectBase.OnSelectionLost ( )

pure virtual

Implements VRage.Game.Entity.UseObject.IMyUseObject.

Implemented in 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, and Sandbox.Game.Entities.Cube.MyUseObjectCryoChamberDoor.

virtual void VRage.Game.Entity.UseObject.MyUseObjectBase.SetInstanceID ( int  id )

inlinevirtual

Implements VRage.Game.Entity.UseObject.IMyUseObject.

Definition at line 80 of file MyUseObjectBase.cs.

virtual void VRage.Game.Entity.UseObject.MyUseObjectBase.SetRenderID ( uint  id )

inlinevirtual

Implements VRage.Game.Entity.UseObject.IMyUseObject.

Definition at line 76 of file MyUseObjectBase.cs.

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

pure virtual

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

Implements VRage.Game.Entity.UseObject.IMyUseObject.

Implemented in 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, and Sandbox.Game.Entities.Cube.MyUseObjectCockpitDoor.

Property Documentation

abstract MatrixD VRage.Game.Entity.UseObject.MyUseObjectBase.ActivationMatrix

get

Definition at line 34 of file MyUseObjectBase.cs.

abstract bool VRage.Game.Entity.UseObject.MyUseObjectBase.ContinuousUsage

get

Definition at line 64 of file MyUseObjectBase.cs.

MyModelDummy VRage.Game.Entity.UseObject.MyUseObjectBase.Dummy

get

Definition at line 23 of file MyUseObjectBase.cs.

virtual int VRage.Game.Entity.UseObject.MyUseObjectBase.InstanceID

get

Definition at line 49 of file MyUseObjectBase.cs.

abstract float VRage.Game.Entity.UseObject.MyUseObjectBase.InteractiveDistance

get

Definition at line 29 of file MyUseObjectBase.cs.

IMyEntity VRage.Game.Entity.UseObject.MyUseObjectBase.Owner

get

Definition at line 17 of file MyUseObjectBase.cs.

abstract bool VRage.Game.Entity.UseObject.MyUseObjectBase.PlayIndicatorSound

get

Definition at line 85 of file MyUseObjectBase.cs.

abstract int VRage.Game.Entity.UseObject.MyUseObjectBase.RenderObjectID

get

Definition at line 44 of file MyUseObjectBase.cs.

abstract bool VRage.Game.Entity.UseObject.MyUseObjectBase.ShowOverlay

get

Definition at line 54 of file MyUseObjectBase.cs.

abstract UseActionEnum VRage.Game.Entity.UseObject.MyUseObjectBase.SupportedActions

get

Definition at line 59 of file MyUseObjectBase.cs.

abstract MatrixD VRage.Game.Entity.UseObject.MyUseObjectBase.WorldMatrix

get

Definition at line 39 of file MyUseObjectBase.cs.

---

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

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