Sandbox.ModAPI.Ingame.IMyChatBroadcastControllerComponent

← Index ← Namespace Index

IMyChatBroadcastControllerComponent Interface

public interface IMyChatBroadcastControllerComponent

Describes entity component for broadcast controller

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

Properties

BroadcastTarget BroadcastTarget { get; set; }

Gets or sets target for messages send from broadcast controller

string CustomName { get; set; }

Custom name that will be visible in chat

int MaxMessageCount { get; }

Number of messages that can be stored in this broadcast controller

bool UseAntenna { get; set; }

Determines if broadcast controller should try to use antenna for broadcasting messages or sent message only to local cube grid

Methods

string GetMessage(int messageIndex)

Gets message at given index

void SendGps()

Sends current position as a message

void SendMessage(int messageIndex)

Sends message

void SendMessage(string message)

Sends custom message

void SendRandomMessage()

Sends randomly one of stored messages

void SetMessage(int messageIndex, string message)

Sets message at given index