IMyLaserAntenna Interface

v01.180.0 (Beta)

[This is preliminary documentation and is subject to change.]

Laser antenna block interface

Namespace: Sandbox.ModAPI.Ingame
Assembly: Sandbox.Common (in Sandbox.Common.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

public interface IMyLaserAntenna : IMyFunctionalBlock, 
	IMyTerminalBlock, IMyCubeBlock, IMyEntity

Public Interface IMyLaserAntenna
	Inherits IMyFunctionalBlock, IMyTerminalBlock, IMyCubeBlock, IMyEntity

public interface class IMyLaserAntenna : IMyFunctionalBlock, 
	IMyTerminalBlock, IMyCubeBlock, IMyEntity

type IMyLaserAntenna =  
    interface
        interface IMyFunctionalBlock
        interface IMyTerminalBlock
        interface IMyCubeBlock
        interface IMyEntity
    end

The IMyLaserAntenna type exposes the following members.

Methods

	Name	Description
	Connect	Connect to target defined by SetTargetCoords
	GetActions	(Inherited from IMyTerminalBlock.)
	GetActionWithName	(Inherited from IMyTerminalBlock.)
	GetInventory	(Inherited from IMyEntity.)
	GetInventory(Int32)	(Inherited from IMyEntity.)
	GetOwnerFactionTag	(Inherited from IMyCubeBlock.)
	GetPlayerRelationToOwner	Obsolete. (Inherited from IMyCubeBlock.)
	GetPosition	(Inherited from IMyEntity.)
	GetProperties	(Inherited from IMyTerminalBlock.)
	GetProperty	(Inherited from IMyTerminalBlock.)
	GetUserRelationToOwner	(Inherited from IMyCubeBlock.)
	HasLocalPlayerAccess	(Inherited from IMyTerminalBlock.)
	HasPlayerAccess	(Inherited from IMyTerminalBlock.)
	RequestEnable	Obsolete. (Inherited from IMyFunctionalBlock.)
	SearchActionsOfName	(Inherited from IMyTerminalBlock.)
	SetCustomName(String)	Obsolete. (Inherited from IMyTerminalBlock.)
	SetCustomName(StringBuilder)	Obsolete. (Inherited from IMyTerminalBlock.)
	SetTargetCoords	Set coordinates of target
	TransmitMessage	Sends a message to the programmable block associated with this antenna's partner. Limited to 100,000 characters.
	UpdateIsWorking	Obsolete. (Inherited from IMyCubeBlock.)
	UpdateVisual	Obsolete. (Inherited from IMyCubeBlock.)

Top

Extension Methods

	Name	Description
	ApplyAction(String)	Overloaded. (Defined by TerminalBlockExtentions.)
	ApplyAction(String, ListTerminalActionParameter)	Overloaded. (Defined by TerminalBlockExtentions.)
	GetDefaultValueT	Returns default value of specified property as TypeName (Defined by TerminalPropertyExtensions.)
	GetId	(Defined by TerminalBlockExtentions.)
	GetInventoryCount	(Defined by TerminalBlockExtentions.)
	GetMaximumT	Returns maximum value of specified property as TypeName (Defined by TerminalPropertyExtensions.)
	GetMinimumT	Returns minimum value of specified property as TypeName (Defined by TerminalPropertyExtensions.)
	GetMininumT	Returns minimum value of specified property as TypeName - this call is obsolete due typo in name, use GetMinimumT(IMyTerminalBlock, String) (Defined by TerminalPropertyExtensions.)
	GetUseConveyorSystem	(Defined by TerminalBlockExtentions.)
	GetValueT	Returns value of specified property as TypeName (Defined by TerminalPropertyExtensions.)
	GetValueBool	Returns value of specified property (Defined by TerminalPropertyExtensions.)
	GetValueColor	Returns value of specified property (Defined by TerminalPropertyExtensions.)
	GetValueFloat	Returns value of specified property (Defined by TerminalPropertyExtensions.)
	HasAction	(Defined by TerminalBlockExtentions.)
	HasInventory	(Defined by TerminalBlockExtentions.)
	SetUseConveyorSystem	(Defined by TerminalBlockExtentions.)
	SetValueT	Set value of property with type of TypeName (Defined by TerminalPropertyExtensions.)
	SetValueBool	Set bool value of property (Defined by TerminalPropertyExtensions.)
	SetValueColor	Set bool value of property (Defined by TerminalPropertyExtensions.)
	SetValueFloat	Set float value of property (Defined by TerminalPropertyExtensions.)

Top

Properties

	Name	Description
	BlockDefinition	(Inherited from IMyCubeBlock.)
	CheckConnectionAllowed	(Inherited from IMyCubeBlock.)
	Components	(Inherited from IMyEntity.)
	CubeGrid	(Inherited from IMyCubeBlock.)
	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.)
	CustomInfo	(Inherited from IMyTerminalBlock.)
	CustomName	(Inherited from IMyTerminalBlock.)
	CustomNameWithFaction	(Inherited from IMyTerminalBlock.)
	DefinitionDisplayNameText	(Inherited from IMyCubeBlock.)
	DetailedInfo	(Inherited from IMyTerminalBlock.)
	DisassembleRatio	(Inherited from IMyCubeBlock.)
	DisplayName	(Inherited from IMyEntity.)
	DisplayNameText	(Inherited from IMyCubeBlock.)
	Enabled	(Inherited from IMyFunctionalBlock.)
	EntityId	(Inherited from IMyEntity.)
	HasInventory	(Inherited from IMyEntity.)
	InventoryCount	(Inherited from IMyEntity.)
	IsBeingHacked	(Inherited from IMyCubeBlock.)
	IsFunctional	(Inherited from IMyCubeBlock.)
	IsOutsideLimits	Obsolete. Target is outside movement limits of antenna
	IsPermanent	Connection is permanent
	IsWorking	(Inherited from IMyCubeBlock.)
	Mass	(Inherited from IMyCubeBlock.)
	Max	(Inherited from IMyCubeBlock.)
	Min	(Inherited from IMyCubeBlock.)
	Name	(Inherited from IMyEntity.)
	NumberInGrid	(Inherited from IMyCubeBlock.)
	Orientation	(Inherited from IMyCubeBlock.)
	OwnerId	(Inherited from IMyCubeBlock.)
	Position	(Inherited from IMyCubeBlock.)
	RequireLoS	Determines whether this particular antenna requires line of sight to function.
	ShowInTerminal	(Inherited from IMyTerminalBlock.)
	ShowInToolbarConfig	(Inherited from IMyTerminalBlock.)
	ShowOnHUD	(Inherited from IMyTerminalBlock.)
	Status	Gets the current status of this antenna.
	TargetCoords	get target coordinates
	WorldAABB	(Inherited from IMyEntity.)
	WorldAABBHr	(Inherited from IMyEntity.)
	WorldMatrix	(Inherited from IMyEntity.)
	WorldVolume	(Inherited from IMyEntity.)
	WorldVolumeHr	(Inherited from IMyEntity.)

Top

Reference

Sandbox.ModAPI.Ingame Namespace