Show / Hide Table of Contents

    Interface IContainerManager

    Interface for a container manager.

    Namespace: Fibula.Items.Contracts.Abstractions
    Assembly: Fibula.Items.Contracts.dll
    Syntax
    public interface IContainerManager

    Methods

    | Improve this Doc View Source

    CloseContainer(UInt32, IContainerItem, Byte)

    Performs a container close action for a player.

    Declaration
    void CloseContainer(uint forCreatureId, IContainerItem containerItem, byte atPosition)
    Parameters
    Type Name Description
    System.UInt32 forCreatureId

    The id of the creature for which the container is being closed.

    IContainerItem containerItem

    The container being closed.

    System.Byte atPosition

    The position in which to close the container, for the player.

    | Improve this Doc View Source

    FindAllForCreature(UInt32)

    Finds all the containers known by the specified creature.

    Declaration
    IEnumerable<IContainerItem> FindAllForCreature(uint creatureId)
    Parameters
    Type Name Description
    System.UInt32 creatureId

    The id of the creature.

    Returns
    Type Description
    System.Collections.Generic.IEnumerable<IContainerItem>

    A collection of containers that the creature knows.

    | Improve this Doc View Source

    FindForCreature(UInt32, IContainerItem)

    Finds the position of a specified container as seen by a specific creature.

    Declaration
    byte FindForCreature(uint creatureId, IContainerItem container)
    Parameters
    Type Name Description
    System.UInt32 creatureId

    The id of the creature for which to find the container.

    IContainerItem container

    The container to look for.

    Returns
    Type Description
    System.Byte

    The position of container found, or UnsetContainerPosition> if not found.

    | Improve this Doc View Source

    FindForCreature(UInt32, Byte)

    Finds a container for a specific creature at the specified position.

    Declaration
    IContainerItem FindForCreature(uint creatureId, byte atPosition)
    Parameters
    Type Name Description
    System.UInt32 creatureId

    The id of the creature for which to find the container.

    System.Byte atPosition

    The position at which to look for the container.

    Returns
    Type Description
    IContainerItem

    The container found, or null if not found.

    | Improve this Doc View Source

    OpenContainer(UInt32, IContainerItem, Byte)

    Performs a container open action for a player.

    Declaration
    void OpenContainer(uint forCreatureId, IContainerItem containerItem, byte atPosition = 255)
    Parameters
    Type Name Description
    System.UInt32 forCreatureId

    The id of the creature for which the container is being opened.

    IContainerItem containerItem

    The container being opened.

    System.Byte atPosition

    The position in which to open the container, for the player.

    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.