Sandbox.ModAPI.Ingame.IMyMessageProvider

← Index ← Namespace Index

IMyMessageProvider Interface

public interface IMyMessageProvider

Base interface for all message providers.

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

Inheritors:

• IMyBroadcastListener
• IMyUnicastListener

Properties

Member	Description
\%1bool HasPendingMessage { get; }](Sandbox.ModAPI.Ingame.IMyMessageProvider.HasPendingMessage)	Determines whether there is a message pending to be accepted in this message provider or not. There may be multiple messages pending in single message provider. In such case the flag will stay raised until the last message is consumed.
\%1int MaxWaitingMessages { get; }](Sandbox.ModAPI.Ingame.IMyMessageProvider.MaxWaitingMessages)	Indicates number of max messages waiting in queue before the oldest one will be dropped to make space for new one.

Methods

Member	Description
\%1MyIGCMessage AcceptMessage()](Sandbox.ModAPI.Ingame.IMyMessageProvider.AcceptMessage)	Accepts first message from pending message queue for this message provider. Messages are guaranteed to be dequeued and returned by this method in order they arrived.
\%1void DisableMessageCallback()](Sandbox.ModAPI.Ingame.IMyMessageProvider.DisableMessageCallback)	Disables registered message callback.
\%1void SetMessageCallback(\%1string])](Sandbox.ModAPI.Ingame.IMyMessageProvider.SetMessageCallback)	Whenever given message provider obtains new message respective programmable block gets called with provided argument. Each raised callback argument will be called only once per simulation tick no matter how many messages are there pending to be accepted. At most a single callback will be invoked each tick ==> If there are messages pending in multiple message providers with registered callback, one will be randomly picked and invoked. Rest will be deferred to the next tick and follow the same process. In case you don't consume all messages pending in given message provider, the callback will not be raise again in following tick unless new message arrives.