VRage.Game.ModAPI.Interfaces.IMyCameraController Interface Reference

Inheritance diagram for VRage.Game.ModAPI.Interfaces.IMyCameraController:

Public Member Functions
void	ControlCamera (MyCamera currentCamera)
	Change camera properties now. Communication: from controller to camera. More...
void	Rotate (Vector2 rotationIndicator, float rollIndicator)
	Rotate camera controller. More...
void	RotateStopped ()
	Rotation of camera controller stopped. More...
void	OnAssumeControl (IMyCameraController previousCameraController)
void	OnReleaseControl (IMyCameraController newCameraController)
bool	HandleUse ()
	Used to send "use" commands to camera controller More...
bool	HandlePickUp ()

Properties
bool	IsInFirstPersonView [get, set]
bool	ForceFirstPersonCamera [get, set]
bool	AllowCubeBuilding [get]

Detailed Description

Definition at line 6 of file IMyCameraController.cs.

Member Function Documentation

void VRage.Game.ModAPI.Interfaces.IMyCameraController.ControlCamera

(

MyCamera

currentCamera

)

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

Parameters

currentCamera

Implemented in Sandbox.Engine.Utils.MyCutsceneCamera.

bool VRage.Game.ModAPI.Interfaces.IMyCameraController.HandlePickUp

(

)

Implemented in Sandbox.Engine.Utils.MyCutsceneCamera.

bool VRage.Game.ModAPI.Interfaces.IMyCameraController.HandleUse

(

)

Used to send "use" commands to camera controller

Returns

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

Implemented in Sandbox.Engine.Utils.MyCutsceneCamera.

void VRage.Game.ModAPI.Interfaces.IMyCameraController.OnAssumeControl

(

IMyCameraController

previousCameraController

)

Implemented in Sandbox.Game.Entities.Character.MyCharacter, Sandbox.Engine.Utils.MySpectatorCameraController, Sandbox.Game.Entities.MyCockpit, Sandbox.Game.Entities.MyCameraBlock, Sandbox.Game.Entities.MyControllableSphere, and Sandbox.Engine.Utils.MyCutsceneCamera.

void VRage.Game.ModAPI.Interfaces.IMyCameraController.OnReleaseControl

(

IMyCameraController

newCameraController

)

Implemented in Sandbox.Game.Entities.Character.MyCharacter, Sandbox.Game.Entities.MyCockpit, Sandbox.Engine.Utils.MySpectatorCameraController, Sandbox.Game.Entities.MyCameraBlock, Sandbox.Game.Entities.MyControllableSphere, and Sandbox.Engine.Utils.MyCutsceneCamera.

void VRage.Game.ModAPI.Interfaces.IMyCameraController.Rotate	(	Vector2	rotationIndicator,
		float	rollIndicator
	)

Rotate camera controller.

Implemented in Sandbox.Game.Entities.Character.MyCharacter, Sandbox.Game.Entities.MyCockpit, Sandbox.Game.Entities.MyCameraBlock, Sandbox.Game.Entities.MyControllableSphere, and Sandbox.Engine.Utils.MyCutsceneCamera.

void VRage.Game.ModAPI.Interfaces.IMyCameraController.RotateStopped

(

)

Rotation of camera controller stopped.

Implemented in Sandbox.Game.Entities.Character.MyCharacter, Sandbox.Game.Entities.MyCockpit, Sandbox.Game.Entities.MyCameraBlock, Sandbox.Game.Entities.MyControllableSphere, and Sandbox.Engine.Utils.MyCutsceneCamera.

Property Documentation

bool VRage.Game.ModAPI.Interfaces.IMyCameraController.AllowCubeBuilding

get

Definition at line 40 of file IMyCameraController.cs.

bool VRage.Game.ModAPI.Interfaces.IMyCameraController.ForceFirstPersonCamera

getset

Definition at line 38 of file IMyCameraController.cs.

bool VRage.Game.ModAPI.Interfaces.IMyCameraController.IsInFirstPersonView

getset

Definition at line 37 of file IMyCameraController.cs.

---

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

• Sources/VRage.Game/ModAPI/Interfaces/IMyCameraController.cs