Interface IMyUseObject

Namespace: VRage.Game.Entity.UseObject
Assembly: VRage.Game.dll
Syntax
public interface IMyUseObject

Properties

ActivationMatrix

Matrix of object, scale represents size of object

Declaration
MatrixD ActivationMatrix { get; }
Property Value
Type Description
MatrixD

ContinuousUsage

When true, use will be called every frame

Declaration
bool ContinuousUsage { get; }
Property Value
Type Description
System.Boolean

Dummy

Declaration
IMyModelDummy Dummy { get; }
Property Value
Type Description
IMyModelDummy

InstanceID

Instance ID of objects (this should mostly be unused

Declaration
int InstanceID { get; }
Property Value
Type Description
System.Int32

InteractiveDistance

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

Declaration
float InteractiveDistance { get; }
Property Value
Type Description
System.Single

Owner

Declaration
IMyEntity Owner { get; }
Property Value
Type Description
IMyEntity

PlayIndicatorSound

Declaration
bool PlayIndicatorSound { get; }
Property Value
Type Description
System.Boolean

PrimaryAction

Main action of this use object

Declaration
UseActionEnum PrimaryAction { get; }
Property Value
Type Description
UseActionEnum

RenderObjectID

Render ID of objects

Declaration
uint RenderObjectID { get; }
Property Value
Type Description
System.UInt32

SecondaryAction

Secondary action of this use object

Declaration
UseActionEnum SecondaryAction { get; }
Property Value
Type Description
UseActionEnum

ShouldUpdateTooltips

Declaration
bool ShouldUpdateTooltips { get; }
Property Value
Type Description
System.Boolean

ShowOverlay

Show overlay (semitransparent bounding box)

Declaration
bool ShowOverlay { get; }
Property Value
Type Description
System.Boolean

SupportedActions

Returns supported actions

Declaration
UseActionEnum SupportedActions { get; }
Property Value
Type Description
UseActionEnum

WorldMatrix

Matrix of object, scale represents size of object

Declaration
MatrixD WorldMatrix { get; }
Property Value
Type Description
MatrixD

Methods

GetActionInfo(UseActionEnum)

Gets action text Caller calls this method only on supported actions

Declaration
MyActionDescription GetActionInfo(UseActionEnum actionEnum)
Parameters
Type Name Description
UseActionEnum actionEnum
Returns
Type Description
MyActionDescription

HandleInput()

Declaration
bool HandleInput()
Returns
Type Description
System.Boolean

OnSelectionLost()

Declaration
void OnSelectionLost()

SetInstanceID(Int32)

Declaration
void SetInstanceID(int id)
Parameters
Type Name Description
System.Int32 id

SetRenderID(UInt32)

Declaration
void SetRenderID(uint id)
Parameters
Type Name Description
System.UInt32 id

Use(UseActionEnum, IMyEntity)

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

Declaration
void Use(UseActionEnum actionEnum, IMyEntity user)
Parameters
Type Name Description
UseActionEnum actionEnum
IMyEntity user

Extension Methods