Space Engineers
Public Member Functions | Properties | List of all members
Sandbox.ModAPI.Ingame.IMyCameraBlock Interface Reference
Inheritance diagram for Sandbox.ModAPI.Ingame.IMyCameraBlock:
Sandbox.ModAPI.Ingame.IMyFunctionalBlock Sandbox.ModAPI.Ingame.IMyTerminalBlock Sandbox.ModAPI.Ingame.IMyTerminalBlock Sandbox.ModAPI.Ingame.IMyCubeBlock Sandbox.ModAPI.Ingame.IMyCubeBlock Sandbox.ModAPI.Ingame.IMyCubeBlock Sandbox.ModAPI.Ingame.IMyCubeBlock Sandbox.ModAPI.IMyCameraBlock Sandbox.Game.Entities.MyCameraBlock

Public Member Functions

MyDetectedEntityInfo Raycast (double distance, float pitch=0, float yaw=0)
 Does a raycast in the direction the camera is facing. Pitch and Yaw are in degrees. Will return an empty struct if distance or angle are out of bounds. More...
 
MyDetectedEntityInfo Raycast (Vector3D targetPos)
 Does a raycast to the given point. Will return an empty struct if distance or angle are out of bounds. More...
 
MyDetectedEntityInfo Raycast (double distance, Vector3D targetDirection)
 Does a raycast in the given direction. Will return an empty struct if distance or angle are out of bounds. More...
 
bool CanScan (double distance)
 Checks if the camera can scan the given distance. More...
 
int TimeUntilScan (double distance)
 Returns the number of milliseconds until the camera can do a raycast of the given distance. More...
 
- Public Member Functions inherited from Sandbox.ModAPI.Ingame.IMyFunctionalBlock
void RequestEnable (bool enable)
 
void RequestEnable (bool enable)
 
- Public Member Functions inherited from Sandbox.ModAPI.Ingame.IMyTerminalBlock
bool HasLocalPlayerAccess ()
 
bool HasPlayerAccess (long playerId)
 
void SetCustomName (string text)
 
void SetCustomName (StringBuilder text)
 
void GetActions (List< Sandbox.ModAPI.Interfaces.ITerminalAction > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalAction, bool > collect=null)
 
void SearchActionsOfName (string name, List< Sandbox.ModAPI.Interfaces.ITerminalAction > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalAction, bool > collect=null)
 
Sandbox.ModAPI.Interfaces.ITerminalAction GetActionWithName (string name)
 
Sandbox.ModAPI.Interfaces.ITerminalProperty GetProperty (string id)
 
void GetProperties (List< Sandbox.ModAPI.Interfaces.ITerminalProperty > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalProperty, bool > collect=null)
 
bool HasLocalPlayerAccess ()
 
bool HasPlayerAccess (long playerId)
 
void RequestShowOnHUD (bool enable)
 
void SetCustomName (string text)
 
void SetCustomName (StringBuilder text)
 
void GetActions (List< Sandbox.ModAPI.Interfaces.ITerminalAction > resultList, Func< Sandbox.ModAPI.Interfaces.ITerminalAction, bool > collect=null)
 
- Public Member Functions inherited from Sandbox.ModAPI.Ingame.IMyCubeBlock
string GetOwnerFactionTag ()
 
Sandbox.Common.MyRelationsBetweenPlayerAndBlock GetPlayerRelationToOwner ()
 
Sandbox.Common.MyRelationsBetweenPlayerAndBlock GetUserRelationToOwner (long playerId)
 
void UpdateIsWorking ()
 
void UpdateVisual ()
 

Properties

double AvailableScanRange [get]
 The maximum distance that this camera can scan, based on the time since the last scan. More...
 
bool EnableRaycast [get, set]
 When this is true, the available raycast distance will count up, and power usage is increased. More...
 
float RaycastConeLimit [get]
 Returns the maximum positive angle you can apply for pitch and yaw. More...
 
double RaycastDistanceLimit [get]
 Returns the maximum distance you can request a raycast. -1 means infinite. More...
 
- Properties inherited from Sandbox.ModAPI.Ingame.IMyFunctionalBlock
bool Enabled [get]
 
- Properties inherited from Sandbox.ModAPI.Ingame.IMyTerminalBlock
string CustomName [get]
 
string CustomNameWithFaction [get]
 
string DetailedInfo [get]
 
string CustomInfo [get]
 
string CustomData [get, set]
 Gets or sets the Custom Data string. NOTE: Only use this for user input. For storing large mod configs, create your own MyModStorageComponent More...
 
bool ShowOnHUD [get]
 
- Properties inherited from Sandbox.ModAPI.Ingame.IMyCubeBlock
Sandbox.Common.ObjectBuilders.Definitions.SerializableDefinitionId BlockDefinition [get]
 
bool CheckConnectionAllowed [get]
 
IMyCubeGrid CubeGrid [get]
 
String DefinitionDisplayNameText [get]
 
float DisassembleRatio [get]
 
String DisplayNameText [get]
 
bool IsBeingHacked [get]
 
bool IsFunctional [get]
 
bool IsWorking [get]
 
VRageMath.Vector3I Max [get]
 
VRageMath.Vector3I Min [get]
 
int NumberInGrid [get]
 
VRageMath.MyBlockOrientation Orientation [get]
 
long OwnerId [get]
 
VRageMath.Vector3I Position [get]
 

Additional Inherited Members

- Events inherited from Sandbox.ModAPI.Ingame.IMyFunctionalBlock
Action< IMyTerminalBlockEnabledChanged
 
- Events inherited from Sandbox.ModAPI.Ingame.IMyTerminalBlock
Action< IMyTerminalBlockCustomNameChanged
 
Action< IMyTerminalBlockOwnershipChanged
 
Action< IMyTerminalBlockPropertiesChanged
 
Action< IMyTerminalBlockShowOnHUDChanged
 
Action< IMyTerminalBlockVisibilityChanged
 
- Events inherited from Sandbox.ModAPI.Ingame.IMyCubeBlock
Action< IMyCubeBlockIsWorkingChanged
 

Detailed Description

Definition at line 9 of file IMyCameraBlock.cs.

Member Function Documentation

bool Sandbox.ModAPI.Ingame.IMyCameraBlock.CanScan ( double  distance)

Checks if the camera can scan the given distance.

Parameters
distance
Returns
MyDetectedEntityInfo Sandbox.ModAPI.Ingame.IMyCameraBlock.Raycast ( double  distance,
float  pitch = 0,
float  yaw = 0 
)

Does a raycast in the direction the camera is facing. Pitch and Yaw are in degrees. Will return an empty struct if distance or angle are out of bounds.

Parameters
distance
pitch
yaw
Returns
MyDetectedEntityInfo Sandbox.ModAPI.Ingame.IMyCameraBlock.Raycast ( Vector3D  targetPos)

Does a raycast to the given point. Will return an empty struct if distance or angle are out of bounds.

Parameters
targetPos
Returns
MyDetectedEntityInfo Sandbox.ModAPI.Ingame.IMyCameraBlock.Raycast ( double  distance,
Vector3D  targetDirection 
)

Does a raycast in the given direction. Will return an empty struct if distance or angle are out of bounds.

Parameters
distance
targetDirection
Returns

Implemented in Sandbox.Game.Entities.MyCameraBlock.

int Sandbox.ModAPI.Ingame.IMyCameraBlock.TimeUntilScan ( double  distance)

Returns the number of milliseconds until the camera can do a raycast of the given distance.

Parameters
distance
Returns

Property Documentation

double Sandbox.ModAPI.Ingame.IMyCameraBlock.AvailableScanRange
get

The maximum distance that this camera can scan, based on the time since the last scan.

Definition at line 41 of file IMyCameraBlock.cs.

bool Sandbox.ModAPI.Ingame.IMyCameraBlock.EnableRaycast
getset

When this is true, the available raycast distance will count up, and power usage is increased.

Definition at line 46 of file IMyCameraBlock.cs.

float Sandbox.ModAPI.Ingame.IMyCameraBlock.RaycastConeLimit
get

Returns the maximum positive angle you can apply for pitch and yaw.

Definition at line 65 of file IMyCameraBlock.cs.

double Sandbox.ModAPI.Ingame.IMyCameraBlock.RaycastDistanceLimit
get

Returns the maximum distance you can request a raycast. -1 means infinite.

Definition at line 70 of file IMyCameraBlock.cs.


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