This repository was archived by the owner on Dec 13, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 123
Sandbox.ModAPI.Ingame.IMyRadioAntenna
Malware edited this page Dec 21, 2018
·
63 revisions
← Index
Namespace: Sandbox.ModAPI.Ingame
Assembly: Sandbox.Common.dll
Implements:
Sandbox.ModAPI.Ingame.IMyFunctionalBlockSandbox.ModAPI.Ingame.IMyTerminalBlockVRage.Game.ModAPI.Ingame.IMyCubeBlockVRage.Game.ModAPI.Ingame.IMyEntity
Antenna block interface
| [`float Radius`](Sandbox.ModAPI.Ingame.Radius) | Broadcasting/Receiving range |
| [`bool ShowShipName`](Sandbox.ModAPI.Ingame.ShowShipName) | Show shipname on hud |
| [`bool IsBroadcasting`](Sandbox.ModAPI.Ingame.IsBroadcasting) | Returns true if antena is broadcasting |
| [`bool EnableBroadcasting`](Sandbox.ModAPI.Ingame.EnableBroadcasting) | Gets or sets if broadcasting is enabled |
| [`long AttachedProgrammableBlock`](Sandbox.ModAPI.Ingame.AttachedProgrammableBlock) | Gets or sets the EntityID of the Programmable Block attached to this antenna. |
| [`bool IgnoreAlliedBroadcast`](Sandbox.ModAPI.Ingame.IgnoreAlliedBroadcast) | Ignores broadcasts sent by friendly antenna that do not belong to you |
| [`bool IgnoreOtherBroadcast`](Sandbox.ModAPI.Ingame.IgnoreOtherBroadcast) | Ignores broadcasts sent by neutral and enemy antenna |
| [`MyEntityComponentContainer Components`](VRage.Game.ModAPI.Ingame.Components) | _Inherited from [`IMyEntity`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`long EntityId`](VRage.Game.ModAPI.Ingame.EntityId) | _Inherited from [`IMyEntity`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`string Name`](VRage.Game.ModAPI.Ingame.Name) | _Inherited from [`IMyEntity`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`string DisplayName`](VRage.Game.ModAPI.Ingame.DisplayName) | _Inherited from [`IMyEntity`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`bool HasInventory`](VRage.Game.ModAPI.Ingame.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`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`int InventoryCount`](VRage.Game.ModAPI.Ingame.InventoryCount) | Returns the count of the number of inventories this entity has. _Inherited from [`IMyEntity`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`BoundingBoxD WorldAABB`](VRage.Game.ModAPI.Ingame.WorldAABB) | _Inherited from [`IMyEntity`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`BoundingBoxD WorldAABBHr`](VRage.Game.ModAPI.Ingame.WorldAABBHr) | _Inherited from [`IMyEntity`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`MatrixD WorldMatrix`](VRage.Game.ModAPI.Ingame.WorldMatrix) | _Inherited from [`IMyEntity`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`BoundingSphereD WorldVolume`](VRage.Game.ModAPI.Ingame.WorldVolume) | _Inherited from [`IMyEntity`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`BoundingSphereD WorldVolumeHr`](VRage.Game.ModAPI.Ingame.WorldVolumeHr) | _Inherited from [`IMyEntity`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`SerializableDefinitionId BlockDefinition`](VRage.Game.ModAPI.Ingame.BlockDefinition) | _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`bool CheckConnectionAllowed`](VRage.Game.ModAPI.Ingame.CheckConnectionAllowed) | _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`IMyCubeGrid CubeGrid`](VRage.Game.ModAPI.Ingame.CubeGrid) | Grid in which the block is placed _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`string DefinitionDisplayNameText`](VRage.Game.ModAPI.Ingame.DefinitionDisplayNameText) | Definition name _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`float DisassembleRatio`](VRage.Game.ModAPI.Ingame.DisassembleRatio) | Is set in definition Ratio at which is the block disassembled (grinding) _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`string DisplayNameText`](VRage.Game.ModAPI.Ingame.DisplayNameText) | Translated block name _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`bool IsBeingHacked`](VRage.Game.ModAPI.Ingame.IsBeingHacked) | Hacking of the block is in progress _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`bool IsFunctional`](VRage.Game.ModAPI.Ingame.IsFunctional) | True if integrity is above breaking threshold _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`bool IsWorking`](VRage.Game.ModAPI.Ingame.IsWorking) | True if block is able to do its work depening on block type (is functional, powered, enabled, etc...) _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`Vector3I Max`](VRage.Game.ModAPI.Ingame.Max) | Maximum coordinates of grid cells occupied by this block _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`float Mass`](VRage.Game.ModAPI.Ingame.Mass) | Block mass _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`Vector3I Min`](VRage.Game.ModAPI.Ingame.Min) | Minimum coordinates of grid cells occupied by this block _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`int NumberInGrid`](VRage.Game.ModAPI.Ingame.NumberInGrid) | Order in which were the blocks of same type added to grid Used in default display name _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`MyBlockOrientation Orientation`](VRage.Game.ModAPI.Ingame.Orientation) | Returns block orientation in base 6 directions _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`long OwnerId`](VRage.Game.ModAPI.Ingame.OwnerId) | Id of player owning block (not steam Id) _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`Vector3I Position`](VRage.Game.ModAPI.Ingame.Position) | Position in grid coordinates _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`string CustomName`](Sandbox.ModAPI.Ingame.CustomName) | _Inherited from [`IMyTerminalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`string CustomNameWithFaction`](Sandbox.ModAPI.Ingame.CustomNameWithFaction) | _Inherited from [`IMyTerminalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`string DetailedInfo`](Sandbox.ModAPI.Ingame.DetailedInfo) | _Inherited from [`IMyTerminalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`string CustomInfo`](Sandbox.ModAPI.Ingame.CustomInfo) | _Inherited from [`IMyTerminalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`string CustomData`](Sandbox.ModAPI.Ingame.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`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`bool ShowOnHUD`](Sandbox.ModAPI.Ingame.ShowOnHUD) | _Inherited from [`IMyTerminalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`bool ShowInTerminal`](Sandbox.ModAPI.Ingame.ShowInTerminal) | _Inherited from [`IMyTerminalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`bool ShowInToolbarConfig`](Sandbox.ModAPI.Ingame.ShowInToolbarConfig) | _Inherited from [`IMyTerminalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`bool ShowInInventory`](Sandbox.ModAPI.Ingame.ShowInInventory) | _Inherited from [`IMyTerminalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`bool Enabled`](Sandbox.ModAPI.Ingame.Enabled) | _Inherited from [`IMyFunctionalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`bool TransmitMessage(string message, MyTransmitTarget target)`](Sandbox.ModAPI.Ingame.TransmitMessage) | Broadcasts a message to all PB attached to the antenna system. Broadcast is delayed until the start of the next tick, and only one transmission can be sent per tick. Returns false if broadcasting failed for any reason. Limited to 100,000 characters. |
| [`IMyInventory GetInventory()`](VRage.Game.ModAPI.Ingame.GetInventory) | Simply get the MyInventoryBase component stored in this entity. _Inherited from [`IMyEntity`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`IMyInventory GetInventory(int index)`](VRage.Game.ModAPI.Ingame.GetInventory) | Search for inventory component with maching index. _Inherited from [`IMyEntity`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`Vector3D GetPosition()`](VRage.Game.ModAPI.Ingame.GetPosition) | _Inherited from [`IMyEntity`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`string GetOwnerFactionTag()`](VRage.Game.ModAPI.Ingame.GetOwnerFactionTag) | Tag of faction owning block _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`MyRelationsBetweenPlayerAndBlock GetPlayerRelationToOwner()`](VRage.Game.ModAPI.Ingame.GetPlayerRelationToOwner) | _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`MyRelationsBetweenPlayerAndBlock GetUserRelationToOwner(long playerId)`](VRage.Game.ModAPI.Ingame.GetUserRelationToOwner) | _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`void UpdateIsWorking()`](VRage.Game.ModAPI.Ingame.UpdateIsWorking) | _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`void UpdateVisual()`](VRage.Game.ModAPI.Ingame.UpdateVisual) | _Inherited from [`IMyCubeBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`bool HasLocalPlayerAccess()`](Sandbox.ModAPI.Ingame.HasLocalPlayerAccess) | _Inherited from [`IMyTerminalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`bool HasPlayerAccess(long playerId)`](Sandbox.ModAPI.Ingame.HasPlayerAccess) | _Inherited from [`IMyTerminalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`void SetCustomName(string text)`](Sandbox.ModAPI.Ingame.SetCustomName) | _Inherited from [`IMyTerminalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`void SetCustomName(StringBuilder text)`](Sandbox.ModAPI.Ingame.SetCustomName) | _Inherited from [`IMyTerminalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`void GetActions(List resultList, Func collect)`](Sandbox.ModAPI.Ingame.GetActions) | _Inherited from [`IMyTerminalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`void SearchActionsOfName(string name, List resultList, Func collect)`](Sandbox.ModAPI.Ingame.SearchActionsOfName) | _Inherited from [`IMyTerminalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`ITerminalAction GetActionWithName(string name)`](Sandbox.ModAPI.Ingame.GetActionWithName) | _Inherited from [`IMyTerminalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`ITerminalProperty GetProperty(string id)`](Sandbox.ModAPI.Ingame.GetProperty) | _Inherited from [`IMyTerminalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`void GetProperties(List resultList, Func collect)`](Sandbox.ModAPI.Ingame.GetProperties) | _Inherited from [`IMyTerminalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`bool IsSameConstructAs(IMyTerminalBlock other)`](Sandbox.ModAPI.Ingame.IsSameConstructAs) | 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`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
| [`void RequestEnable(bool enable)`](Sandbox.ModAPI.Ingame.RequestEnable) | _Inherited from [`IMyFunctionalBlock`](Sandbox.ModAPI.Ingame.IMyRadioAntenna)_ |
Do you have questions, comments, suggestions for improvements? Is there something I can do better? Did I make a mistake? Please add an issue here, and prefix your issue title with Wiki. Thank you, your help will be very appreciated!