IMyRadioAntenna.TransmitMessage Method

IMyRadioAntennaTransmitMessage Method

v01.180.0 (Beta)

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

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.

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

Syntax

C++

Copy

bool TransmitMessage(
	string message,
	MyTransmitTarget target = MyTransmitTarget.Default
)

Function TransmitMessage ( 
	message As String,
	Optional target As MyTransmitTarget = MyTransmitTarget.Default
) As Boolean

bool TransmitMessage(
	String^ message, 
	MyTransmitTarget target = MyTransmitTarget::Default
)

abstract TransmitMessage : 
        message : string * 
        ?target : MyTransmitTarget 
(* Defaults:
        let _target = defaultArg target MyTransmitTarget.Default
*)
-> bool

Parameters

Return Value

Reference