Interface IMySignalReceiverEntityComponent
Describes entity component for triggering toolbar-defined actions when receiving a signal
Namespace: Sandbox.ModAPI
Assembly: Sandbox.Common.dll
Syntax
public interface IMySignalReceiverEntityComponentProperties
AllowSignalsFrom
Gets or sets MyTransponderRelationFilter which defines allowed relation between signal sender and signal receiver.
Declaration
MyTransponderRelationFilter AllowSignalsFrom { get; set; }Property Value
| Type | Description |
|---|---|
| MyTransponderRelationFilter |
Methods
Receive(Int64, Int32)
Checks the channel and relations between receivers' owner and signal sender, triggers if appropriate to do so
Declaration
bool Receive(long signalSenderOwnerPlayerId, int incomingChannelId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | signalSenderOwnerPlayerId | |
| System.Int32 | incomingChannelId |
Returns
| Type | Description |
|---|---|
| System.Boolean | true if conditions matched, false otherwise |
Events
SignalReceived
Called when a signal is received
Declaration
event Action<int> SignalReceivedEvent Type
| Type | Description |
|---|---|
| System.Action<System.Int32> |
TriggeredBySignal
Called when successfully triggered by a signal
Declaration
event Action<int> TriggeredBySignalEvent Type
| Type | Description |
|---|---|
| System.Action<System.Int32> |