Table of Contents

Class TryGoHereAction

Namespace
TinyLife.Actions
Assembly
Tiny Life.dll

This action is similar to GoHereAction, but considers all involved locations (GetInvolvedLocations()) rather than a single position. The action's PersonLike will then try to pathfind to each one of the positions in a random order, until one of them is valid, and go to it.

public class TryGoHereAction : Action, IGenericDataHolder
Inheritance
JsonTypeSafeGenericDataHolder
TryGoHereAction
Implements
IGenericDataHolder
Inherited Members
JsonTypeSafeGenericDataHolder.GetDataKeys()
Extension Methods

Constructors

TryGoHereAction(ActionInfo)

Creates a new typeless action with the given action information.

[JsonConstructor]
public TryGoHereAction(ActionInfo info)

Parameters

info ActionInfo

The information for this action.

TryGoHereAction(PersonLike, IEnumerable<(Map Map, Point Pos, float Floor)>) 

public TryGoHereAction(PersonLike person, IEnumerable<(Map Map, Point Pos, float Floor)> positions)

Parameters

person PersonLike
positions IEnumerable<(Map Map, Point Pos, float Floor)>

TryGoHereAction(PersonLike, IEnumerable<(Map Map, Vector2 Pos, float Floor)>) 

public TryGoHereAction(PersonLike person, IEnumerable<(Map Map, Vector2 Pos, float Floor)> positions)

Parameters

person PersonLike
positions IEnumerable<(Map Map, Vector2 Pos, float Floor)>

Methods

Initialize()

This method is called when the action is first started by a Person. Note that it is not called when the action gets added to the ActionQueue, but when it is moved to CurrentActions.

public override void Initialize()

IsCompleted()

This method is called every update frame by a Person if this action is currently active to check if it should be stopped. If this returns a result other than Completed, OnCompleted(CompletionType) will be called and the action is stopped. By default, only ForceResult modifies the completion type, otherwise Active is returned.

public override CompletionType IsCompleted()

Returns

CompletionType

The current completion type of this action

OnCompleted(CompletionType)

This method is called when this action IsCompleted(), or if it is canceled from an outside source. Note that, if this method is called as a result of IsCompleted(), the CompletionType passed will be the same. By default, only OnActionCompleted(Action, CompletionType, bool) is called.

public override void OnCompleted(CompletionType type)

Parameters

type CompletionType

The type that this action completed with

Update(GameTime, TimeSpan, float)

This method is called every update frame if this action is currently active. By default, only the ElapsedTime is modified in this method and ActionUpdate(Action, GameTime, TimeSpan, float, bool) is called.

public override void Update(GameTime time, TimeSpan passedInGame, float speedMultiplier)

Parameters

time GameTime

The current game time

passedInGame TimeSpan

The amount of time that has passed, in game time

speedMultiplier float

The game speed multiplier, which represents how fast things should happen, which is usually determined by Speed

Validate(PersonLike, AppliedMigrations)

Validates this action's data. This is called when a map is loaded from disk. When returning false on this method, the action is removed from the Person.

public override bool Validate(PersonLike person, AppliedMigrations appliedMigrations)

Parameters

person PersonLike

The person that this action belongs to

appliedMigrations AppliedMigrations

The migrations that have been applied so far

Returns

bool

Whether or not the action is still valid (or if it has invalid data)