Class CreatureTurnedNotification

Class that represents a notification for when a creature has turned.

Inheritance
System.Object
Priority_Queue.FastPriorityQueueNode
Priority_Queue.StablePriorityQueueNode
BaseEvent
Notification
CreatureTurnedNotification
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 CreatureTurnedNotification : Notification, IEquatable<BaseEvent>, INotification, IEvent

Constructors

| Improve this Doc View Source

CreatureTurnedNotification(Func<IEnumerable<IPlayer>>, ICreature, Byte, AnimatedEffect)

Initializes a new instance of the CreatureTurnedNotification class.

Declaration
public CreatureTurnedNotification(Func<IEnumerable<IPlayer>> findTargetPlayers, ICreature creature, byte creatureStackPosition, AnimatedEffect turnEffect = AnimatedEffect.None)
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 turned.
System.Byte creatureStackPosition

The position in the stack of the creature that turned.
AnimatedEffect turnEffect

Optional. An effect of the turn.

Properties

| Improve this Doc View Source

Creature

Gets the creature that turned.

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

StackPosition

Gets the position in the stack of the creatue.

Declaration
public byte StackPosition { get; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

TurnedEffect

Gets the effect of the turn, if any.

Declaration
public AnimatedEffect TurnedEffect { get; }
Property Value
Type Description
AnimatedEffect

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