Show / Hide Table of Contents

    Interface IThing

    Interface for all things in the game.

    Inherited Members
    ILocatable.Location
    ILocatable.CarryLocation
    IContainedThing.ParentContainer
    System.IEquatable<Fibula.Common.Contracts.Abstractions.IThing>.Equals(Fibula.Common.Contracts.Abstractions.IThing)
    ICloneableThing<IThing>.Clone()
    Namespace: Fibula.Common.Contracts.Abstractions
    Assembly: Fibula.Common.Contracts.dll
    Syntax
    public interface IThing : ILocatable, IContainedThing, IEquatable<IThing>, ICloneableThing<IThing>

    Properties

    | Improve this Doc View Source

    CanBeMoved

    Gets a value indicating whether this thing can be moved.

    Declaration
    bool CanBeMoved { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    TrackedEvents

    Gets the tracked events for this thing.

    Declaration
    IDictionary<string, IEvent> TrackedEvents { get; }
    Property Value
    Type Description
    System.Collections.Generic.IDictionary<System.String, IEvent>
    | Improve this Doc View Source

    TypeId

    Gets the id of this thing.

    Declaration
    ushort TypeId { get; }
    Property Value
    Type Description
    System.UInt16
    | Improve this Doc View Source

    UniqueId

    Gets the unique id of this thing.

    Declaration
    Guid UniqueId { get; }
    Property Value
    Type Description
    System.Guid

    Methods

    | Improve this Doc View Source

    DescribeForLogger()

    Provides a string describing the current thing for logging purposes.

    Declaration
    string DescribeForLogger()
    Returns
    Type Description
    System.String

    The string to log.

    | Improve this Doc View Source

    StartTrackingEvent(IEvent, String)

    Makes the thing start tracking an event.

    Declaration
    void StartTrackingEvent(IEvent evt, string identifier = "")
    Parameters
    Type Name Description
    IEvent evt

    The event to stop tracking.

    System.String identifier

    Optional. The identifier under which to start tracking the event. If no identifier is provided, the event's type name is used.

    | Improve this Doc View Source

    StopTrackingEvent(IEvent, String)

    Makes the thing stop tracking an event.

    Declaration
    void StopTrackingEvent(IEvent evt, string identifier = "")
    Parameters
    Type Name Description
    IEvent evt

    The event to stop tracking.

    System.String identifier

    Optional. The identifier under which to look for and stop tracking the event. If no identifier is provided, the event's type name is used.

    Events

    | Improve this Doc View Source

    LocationChanged

    Event to invoke when any of the properties of this thing have changed.

    Declaration
    event OnLocationChanged LocationChanged
    Event Type
    Type Description
    OnLocationChanged

    Extension Methods

    ContainerExtensions.GetParentContainerHierarchy(IContainedThing, Boolean)
    ThingExtensions.RemainingExhaustionTime(IThing, ExhaustionType, DateTimeOffset)
    ThingExtensions.HasCondition(IThing, ConditionType)
    ThingExtensions.IsExhausted(IThing, ExhaustionType)
    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.