Show / Hide Table of Contents

    Interface IHotspotComponent

    Allows an entity to act as a hotspot (i.e can be interacted with).

    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
    public interface IHotspotComponent : IComponent, IDisposable, INotifyPropertyChanged

    Properties

    | Improve this Doc View Source

    DisplayHotspot

    Gets or sets whether the hotspot name should be shown by a hotspot label when hovering over the entity. DisplayName

    Declaration
    bool DisplayHotspot { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if display hotspot's name; otherwise, false.

    | Improve this Doc View Source

    Interactions

    Allows subscribing to interaction events for this entity.

    Declaration
    IInteractions Interactions { get; }
    Property Value
    Type Description
    IInteractions

    The interactions.

    See Also
    IInteractions
    | Improve this Doc View Source

    WalkPoint

    Gets or sets an optional walk point for the entity which might be used before interacting with the entity, depending on how the IApproachComponent is configured.

    Declaration
    PointF? WalkPoint { get; set; }
    Property Value
    Type Description
    System.Nullable<PointF>

    The walk point.

    See Also
    IApproachStyle
    • Improve this Doc
    • View Source
    Back to top Generated by DocFX