Interface IApproachComponent

Allows a character to approach a hotspot. When an interaction event is triggered for a hotspot, if this component is available for the player (which it is by default), then the character will approach the hotspot before the interaction logic code is triggered.

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(IFaceDirectionComponent), true)]
[RequiredComponent(typeof(IWalkComponent), true)]
public interface IApproachComponent : IComponent, IDisposable, INotifyPropertyChanged

Properties

ApproachStyle

Gets or sets the approach style.

Declaration

IApproachStyle ApproachStyle { get; set; }

Property Value

Type	Description
IApproachStyle	The approach style.

Methods

ApproachAsync(String, IObject)

Approachs the target hotspot for the given verb (Look, Interact, etc).

Declaration

Task<bool> ApproachAsync(string verb, IObject target)

Parameters

Type	Name	Description
System.String	verb	The verb (Look, Interact, etc).
IObject	target	The target hotspot.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	Did the approach complete successfully? (i.e was not interrupted by the player or any other game code).