Class CreatureSpeechNotification

Class that represents a notification for a creature speech.

Inheritance
System.Object
Priority_Queue.FastPriorityQueueNode
Priority_Queue.StablePriorityQueueNode
BaseEvent
Notification
CreatureSpeechNotification
Implements
System.IEquatable<BaseEvent>
Inherited Members
Priority_Queue.StablePriorityQueueNode.InsertionIndex
Priority_Queue.FastPriorityQueueNode.Priority
Priority_Queue.FastPriorityQueueNode.QueueIndex
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Fibula.Mechanics.Notifications
Assembly: Fibula.Mechanics.dll
Syntax
public class CreatureSpeechNotification : Notification, IEquatable<BaseEvent>, INotification, IEvent

Constructors

| Improve this Doc View Source

CreatureSpeechNotification(Func<IEnumerable<IPlayer>>, ICreature, SpeechType, ChatChannelType, String, String)

Initializes a new instance of the CreatureSpeechNotification class.

Declaration
public CreatureSpeechNotification(Func<IEnumerable<IPlayer>> findTargetPlayers, ICreature creature, SpeechType speechType, ChatChannelType channelType, string text, string receiver = "")
Parameters
Type Name Description
System.Func<System.Collections.Generic.IEnumerable<IPlayer>> findTargetPlayers

A function to determine the target players of this notification.
ICreature creature

The creature that spoke.
SpeechType speechType

The type of speech.
ChatChannelType channelType

The channel type.
System.String text

The message content.
System.String receiver

Optional. The receiver of the message.

Properties

| Improve this Doc View Source

ChannelType

Gets the type of channel.

Declaration
public ChatChannelType ChannelType { get; }
Property Value
Type Description
ChatChannelType
| Improve this Doc View Source

Creature

Gets the id of the creature that spoke.

Declaration
public ICreature Creature { get; }
Property Value
Type Description
ICreature
| Improve this Doc View Source

Receiver

Gets the receiver of the speech, if this is a private channel message.

Declaration
public string Receiver { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

SpeechType

Gets the type of speech.

Declaration
public SpeechType SpeechType { get; }
Property Value
Type Description
SpeechType
| Improve this Doc View Source

Text

Gets the text of the speech.

Declaration
public string Text { get; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

Prepare(INotificationContext, IPlayer)

Finalizes the notification in preparation to it being sent.

Declaration
protected override IEnumerable<IOutboundPacket> Prepare(INotificationContext context, IPlayer player)
Parameters
Type Name Description
INotificationContext context

The context of this notification.
IPlayer player

The player which this notification is being prepared for.
Returns
Type Description
System.Collections.Generic.IEnumerable<IOutboundPacket>

A collection of IOutboundPackets, the ones to be sent.
Overrides

Implements

System.IEquatable<T>

Extension Methods