Skip to content
This repository was archived by the owner on Dec 13, 2025. It is now read-only.

Sandbox.ModAPI.Ingame.IMyCameraBlock

Malware edited this page Dec 21, 2018 · 59 revisions

Index

IMyCameraBlock Interface

Namespace: Sandbox.ModAPI.Ingame
Assembly: Sandbox.Common.dll
Implements:

Properties

Member Description
bool IsActive Determines whether this camera is currently in use.
double AvailableScanRange The maximum distance that this camera can scan, based on the time since the last scan.
bool EnableRaycast When this is true, the available raycast distance will count up, and power usage is increased.
float RaycastConeLimit Returns the maximum positive angle you can apply for pitch and yaw.
double RaycastDistanceLimit Returns the maximum distance you can request a raycast. -1 means infinite.
MyEntityComponentContainer Components Inherited from IMyEntity
long EntityId Inherited from IMyEntity
string Name Inherited from IMyEntity
string DisplayName Inherited from IMyEntity
bool HasInventory Returns true if this entity has got at least one inventory. Note that one aggregate inventory can contain zero simple inventories => zero will be returned even if GetInventory() != null.

Inherited from IMyEntity
int InventoryCount Returns the count of the number of inventories this entity has.

Inherited from IMyEntity
BoundingBoxD WorldAABB Inherited from IMyEntity
BoundingBoxD WorldAABBHr Inherited from IMyEntity
MatrixD WorldMatrix Inherited from IMyEntity
BoundingSphereD WorldVolume Inherited from IMyEntity
BoundingSphereD WorldVolumeHr Inherited from IMyEntity
SerializableDefinitionId BlockDefinition Inherited from IMyCubeBlock
bool CheckConnectionAllowed Inherited from IMyCubeBlock
IMyCubeGrid CubeGrid Grid in which the block is placed

Inherited from IMyCubeBlock
string DefinitionDisplayNameText Definition name

Inherited from IMyCubeBlock
float DisassembleRatio Is set in definition Ratio at which is the block disassembled (grinding)

Inherited from IMyCubeBlock
string DisplayNameText Translated block name

Inherited from IMyCubeBlock
bool IsBeingHacked Hacking of the block is in progress

Inherited from IMyCubeBlock
bool IsFunctional True if integrity is above breaking threshold

Inherited from IMyCubeBlock
bool IsWorking True if block is able to do its work depening on block type (is functional, powered, enabled, etc...)

Inherited from IMyCubeBlock
Vector3I Max Maximum coordinates of grid cells occupied by this block

Inherited from IMyCubeBlock
float Mass Block mass

Inherited from IMyCubeBlock
Vector3I Min Minimum coordinates of grid cells occupied by this block

Inherited from IMyCubeBlock
int NumberInGrid Order in which were the blocks of same type added to grid Used in default display name

Inherited from IMyCubeBlock
MyBlockOrientation Orientation Returns block orientation in base 6 directions

Inherited from IMyCubeBlock
long OwnerId Id of player owning block (not steam Id)

Inherited from IMyCubeBlock
Vector3I Position Position in grid coordinates

Inherited from IMyCubeBlock
string CustomName Inherited from IMyTerminalBlock
string CustomNameWithFaction Inherited from IMyTerminalBlock
string DetailedInfo Inherited from IMyTerminalBlock
string CustomInfo Inherited from IMyTerminalBlock
string CustomData Gets or sets the Custom Data string. NOTE: Only use this for user input. For storing large mod configs, create your own MyModStorageComponent

Inherited from IMyTerminalBlock
bool ShowOnHUD Inherited from IMyTerminalBlock
bool ShowInTerminal Inherited from IMyTerminalBlock
bool ShowInToolbarConfig Inherited from IMyTerminalBlock
bool ShowInInventory Inherited from IMyTerminalBlock
bool Enabled Inherited from IMyFunctionalBlock

Methods

Member Description
MyDetectedEntityInfo Raycast(double distance, float pitch, float yaw) 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.
MyDetectedEntityInfo Raycast(Vector3D targetPos) Does a raycast to the given point. Will return an empty struct if distance or angle are out of bounds.
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.
bool CanScan(double distance) Checks if the camera can scan the given distance.
bool CanScan(double distance, Vector3D direction) Checks if the camera can scan to the given direction and distance.
bool CanScan(Vector3D target) Checks if the camera can scan to the given target
int TimeUntilScan(double distance) Returns the number of milliseconds until the camera can do a raycast of the given distance.
IMyInventory GetInventory() Simply get the MyInventoryBase component stored in this entity.

Inherited from IMyEntity
IMyInventory GetInventory(int index) Search for inventory component with maching index.

Inherited from IMyEntity
Vector3D GetPosition() Inherited from IMyEntity
string GetOwnerFactionTag() Tag of faction owning block

Inherited from IMyCubeBlock
MyRelationsBetweenPlayerAndBlock GetPlayerRelationToOwner() Inherited from IMyCubeBlock
MyRelationsBetweenPlayerAndBlock GetUserRelationToOwner(long playerId) Inherited from IMyCubeBlock
void UpdateIsWorking() Inherited from IMyCubeBlock
void UpdateVisual() Inherited from IMyCubeBlock
bool HasLocalPlayerAccess() Inherited from IMyTerminalBlock
bool HasPlayerAccess(long playerId) Inherited from IMyTerminalBlock
void SetCustomName(string text) Inherited from IMyTerminalBlock
void SetCustomName(StringBuilder text) Inherited from IMyTerminalBlock
void GetActions(List<ITerminalAction> resultList, Func<ITerminalAction, bool> collect) Inherited from IMyTerminalBlock
void SearchActionsOfName(string name, List<ITerminalAction> resultList, Func<ITerminalAction, bool> collect) Inherited from IMyTerminalBlock
ITerminalAction GetActionWithName(string name) Inherited from IMyTerminalBlock
ITerminalProperty GetProperty(string id) Inherited from IMyTerminalBlock
void GetProperties(List<ITerminalProperty> resultList, Func<ITerminalProperty, bool> collect) Inherited from IMyTerminalBlock
bool IsSameConstructAs(IMyTerminalBlock other) Determines whether this block is mechanically connected to the other. This is any block connected with rotors or pistons or other mechanical devices, but not things like connectors. This will in most cases constitute your complete construct.
Be aware that using merge blocks combines grids into one, so this function will not filter out grids connected that way. Also be aware that detaching the heads of pistons and rotors will cause this connection to change.

Inherited from IMyTerminalBlock
void RequestEnable(bool enable) Inherited from IMyFunctionalBlock

Clone this wiki locally