Class CreatureRemovedNotification

Class that represents a notification for a creature being removed.

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

Constructors

| Improve this Doc View Source

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

Initializes a new instance of the CreatureRemovedNotification class.

Declaration
public CreatureRemovedNotification(Func<IEnumerable<IPlayer>> findTargetPlayers, ICreature creature, byte oldStackPos, AnimatedEffect removeEffect = 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 being removed.
System.Byte oldStackPos

The position in the stack of the creature being removed.
AnimatedEffect removeEffect

Optional. An effect to add when removing the creature.

Properties

| Improve this Doc View Source

Creature

Gets the creature being removed.

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

RemoveEffect

Gets the effect to send when removing the creature.

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

StackPosition

Gets the stack position of the creature being removed.

Declaration
public byte StackPosition { get; }
Property Value
Type Description
System.Byte

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