Show / Hide Table of Contents

    Interface IInventoryWindowComponent

    An inventory window allows displaying inventory items in a window.

    Inherited Members
    IComponent.Name
    IComponent.Entity
    IComponent.RegistrationType
    IComponent.Init(IEntity, Type)
    IComponent.AfterInit()
    System.IDisposable.Dispose()
    System.ComponentModel.INotifyPropertyChanged.PropertyChanged
    Namespace: AGS.API
    Assembly: AGS.API.dll
    Syntax
    [RequiredComponent(typeof(IScaleComponent), true)]
    [RequiredComponent(typeof(IInObjectTreeComponent), true)]
    public interface IInventoryWindowComponent : IComponent, IDisposable, INotifyPropertyChanged

    Properties

    | Improve this Doc View Source

    Inventory

    Gets or sets the inventory which is displayed in the window.

    Declaration
    IInventory Inventory { get; set; }
    Property Value
    Type Description
    IInventory

    The inventory.

    | Improve this Doc View Source

    ItemSize

    Gets or sets the size which is allocated to each inventory item in the window.

    Declaration
    SizeF ItemSize { get; set; }
    Property Value
    Type Description
    SizeF

    The size of the item.

    | Improve this Doc View Source

    ItemsPerRow

    Gets the number of items that fit in one row.

    Declaration
    int ItemsPerRow { get; }
    Property Value
    Type Description
    System.Int32

    The items per row.

    | Improve this Doc View Source

    PaddingBetweenItems

    Optional padding to apply between the inventory items.

    Declaration
    SizeF PaddingBetweenItems { get; set; }
    Property Value
    Type Description
    SizeF

    The padding between the inventory items.

    | Improve this Doc View Source

    PaddingBottom

    Optional padding from the bottom side of the inventory window containing panel.

    Declaration
    float PaddingBottom { get; set; }
    Property Value
    Type Description
    System.Single

    The bottom padding.

    | Improve this Doc View Source

    PaddingLeft

    Optional padding from the left side of the inventory window containing panel.

    Declaration
    float PaddingLeft { get; set; }
    Property Value
    Type Description
    System.Single

    The left padding.

    | Improve this Doc View Source

    PaddingRight

    Optional padding from the right side of the inventory window containing panel.

    Declaration
    float PaddingRight { get; set; }
    Property Value
    Type Description
    System.Single

    The right padding.

    | Improve this Doc View Source

    PaddingTop

    Optional padding from the top side of the inventory window containing panel.

    Declaration
    float PaddingTop { get; set; }
    Property Value
    Type Description
    System.Single

    The top padding.

    | Improve this Doc View Source

    RowCount

    Gets the number of rows the inventory currently needs to be fully displayed.

    Declaration
    int RowCount { get; }
    Property Value
    Type Description
    System.Int32

    The row count.

    | Improve this Doc View Source

    TopItem

    Gets or sets the top item index for the current view of the window. If the top item is 0, the window will show starting from the first item, and up to the number of items that fit in the window. If the top item is 1, the window will skip the first item, and so on.

    Declaration
    int TopItem { get; set; }
    Property Value
    Type Description
    System.Int32

    The top item.

    Methods

    | Improve this Doc View Source

    ScrollDown()

    Scrolls the inventory window down one row if possible (TopItem will change accordingly)

    Declaration
    void ScrollDown()
    | Improve this Doc View Source

    ScrollUp()

    Scrolls the inventory window up one row if possible (TopItem will change accordingly).

    Declaration
    void ScrollUp()

    See Also

    IInventory
    IInventoryItem
    • Improve this Doc
    • View Source
    Back to top Generated by DocFX