Interface IMyCameraController

Interface to control game camera (not block) (mods interface)

Namespace: VRage.Game.ModAPI.Interfaces

Assembly: VRage.Game.dll

Syntax

public interface IMyCameraController

Properties

AllowCubeBuilding

Gets if player block building enabled

Declaration

bool AllowCubeBuilding { get; }

Property Value

Type	Description
System.Boolean

EnableFirstPersonView

Gets or set if player can use first person view

Declaration

bool EnableFirstPersonView { get; set; }

Property Value

Type	Description
System.Boolean

Entity

Gets Entity to which it is attached

Declaration

MyEntity Entity { get; }

Property Value

Type	Description
MyEntity

ForceFirstPersonCamera

Gets or sets if player can use only first person view

Declaration

bool ForceFirstPersonCamera { get; set; }

Property Value

Type	Description
System.Boolean

IsInFirstPersonView

Gets or sets if the current camera view is first person.

Declaration

bool IsInFirstPersonView { get; set; }

Property Value

Type	Description
System.Boolean

Methods

ControlCamera(MyCamera)

Change camera properties now. Communication: from controller to camera.

Declaration

void ControlCamera(MyCamera currentCamera)

Parameters

Type	Name	Description
VRage.Game.Utils.MyCamera	currentCamera

GetOverridingFocusMatrix()

Transformation that should be used for target selection while focusing

Declaration

Nullable<MatrixD> GetOverridingFocusMatrix()

Returns

Type	Description
System.Nullable<MatrixD>

HandlePickUp()

Does nothing.

Declaration

bool HandlePickUp()

Returns

Type	Description
System.Boolean	Always returns false

HandleUse()

Used to send "use" commands to camera controller

Declaration

bool HandleUse()

Returns

Type	Description
System.Boolean	Return value indicates if the camera controller handled the use button. If not, it should fall to ControlledObject

OnAssumeControl(IMyCameraController)

Called when it is setted as new main camera controller

Declaration

void OnAssumeControl(IMyCameraController previousCameraController)

Parameters

Type	Name	Description
IMyCameraController	previousCameraController	Previous camera controller

OnReleaseControl(IMyCameraController)

Called when new camera controller setted, and this was main camera controller

Declaration

void OnReleaseControl(IMyCameraController newCameraController)

Parameters

Type	Name	Description
IMyCameraController	newCameraController	New main camera controller

Rotate(Vector2, Single)

Rotate camera controller.

Declaration

void Rotate(Vector2 rotationIndicator, float rollIndicator)

Parameters

Type	Name	Description
Vector2	rotationIndicator
System.Single	rollIndicator

RotateStopped()

Rotation of camera controller stopped.

Declaration

void RotateStopped()