Show / Hide Table of Contents

    Class AnimatedTextNotification

    Class that represents a notification for animated effects.

    Inheritance
    System.Object
    Priority_Queue.FastPriorityQueueNode
    Priority_Queue.StablePriorityQueueNode
    BaseEvent
    Notification
    AnimatedTextNotification
    Implements
    System.IEquatable<BaseEvent>
    INotification
    IEvent
    Inherited Members
    Notification.Sent
    Notification.CanBeCancelled
    Notification.Execute(IEventContext)
    Notification.Send(INotificationContext)
    BaseEvent.Cancelled
    BaseEvent.Expedited
    BaseEvent.Completed
    BaseEvent.EventId
    BaseEvent.RequestorId
    BaseEvent.RepeatAfter
    BaseEvent.HasCancellationHandler
    BaseEvent.HasExpeditionHandler
    BaseEvent.ExcludeFromTelemetry
    BaseEvent.State
    BaseEvent.Cancel()
    BaseEvent.Expedite()
    BaseEvent.Complete(Boolean)
    BaseEvent.Equals(BaseEvent)
    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 AnimatedTextNotification : Notification, IEquatable<BaseEvent>, INotification, IEvent

    Constructors

    | Improve this Doc View Source

    AnimatedTextNotification(Func<IEnumerable<IPlayer>>, Location, TextColor, String)

    Initializes a new instance of the AnimatedTextNotification class.

    Declaration
    public AnimatedTextNotification(Func<IEnumerable<IPlayer>> findTargetPlayers, Location location, TextColor color, string text)
    Parameters
    Type Name Description
    System.Func<System.Collections.Generic.IEnumerable<IPlayer>> findTargetPlayers

    A function to determine the target players of this notification.

    Location location

    The location of the animated text.

    TextColor color

    The color of text to send.

    System.String text

    The text to send.

    Properties

    | Improve this Doc View Source

    Color

    Gets the text color.

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

    Location

    Gets the location of the animated text.

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

    Text

    Gets the text value.

    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
    Notification.Prepare(INotificationContext, IPlayer)

    Implements

    System.IEquatable<T>
    INotification
    IEvent

    Extension Methods

    ObjectExtensions.YieldSingleItem<T>(T)
    ObjectExtensions.GetPropertyValue(Object, String)
    Validate.ThrowIfNull(Object, String)
    • Improve this Doc
    • View Source
    Back to top Copyright © 2018-2020 | The Fibula Project
    Generated using DocFX | Jose L. Nuñez de Caceres et al.