Class DebugAction

Namespace

TinyLife.Actions

Assembly

TinyLife.dll

An abstract class that can be used to easily create debug-only actions that are available when TinyLife.Debug.ShowDebugActions is enabled. They complete immediately when started and invoke their Run() method once on completion. A debug action type should be created using Create(string, ObjectCategory, Type, CanExecuteDelegate) or one of its overloads.

public abstract class DebugAction : Action, IGenericDataHolder

Inheritance

object

JsonTypeSafeGenericDataHolder

Action

DebugAction

Implements

IGenericDataHolder

Inherited Members

Action.Random

Action.Migrations

Action.OnActionTypeConstructed

Action.InProgressTime

Action.FullyInProgress

Action.Type

Action.Info

Action.Id

Action.StartedAutomatically

Action.Parent

Action.Person

Action.ElapsedTime

Action.PlayerPromptOpen

Action.Initialize()

Action.Update(GameTime, TimeSpan, float)

Action.Validate(PersonLike, AppliedMigrations)

Action.CanStartNow()

Action.CanActionInterrupt(Action)

Action.CanGenericInterrupt(bool)

Action.CanObjectInterrupt(MapObject, CanExecuteResult)

Action.Interrupt(CompletionType)

Action.GetNextAction(CompletionType)

Action.GetIconObject()

Action.GetExtraIcon()

Action.CausesExtremelyFastSpeed()

Action.GetDisplayName()

Action.CanEnqueueConversation(PersonLike, ActionType)

Action.GetProgress()

Action.OnChildCompleted(Action, CompletionType, bool)

Action.OpenPlayerPrompt(string, Predicate<Panel>, Action<Panel>, bool, Action<CoveringGroup, Panel>, TextureRegion, float, bool)

Action.OpenYesNoPrompt(string, Action, Action, TextureRegion, Action<CoveringGroup, Panel>)

Action.OpenTextPrompt(string, Action<string>, Predicate<string>, TextField.Rule, string, bool, int?, TextureRegion, Action<CoveringGroup, Panel>)

Action.OpenStackableItemSelectionPrompt<T>(string, IEnumerable<Stackable<T>>, Predicate<List<Stackable<T>>>, Action<List<Stackable<T>>>, bool, Func<Stackable<T>, string>, Func<Stackable<T>, TextureRegion>, TextureRegion, Action<CoveringGroup, Panel, List<Stackable<T>>>)

Action.OpenChoicePrompt(ChoicePromptInfo)

Action.SpeakAlone(GameTime, float, EmoteChoices?, SpeakStyle, int, float, float, float, float, EmoteBubbleType?)

Action.ThinkAlone(GameTime, float, EmoteChoices, float, float, float, float, int, EmoteBubbleType?)

Action.SpeakInConversation(PersonLike, GameTime, float, EmoteChoices?, SpeakStyle, EmoteChoices?, SpeakStyle?, int, float, float, float, float, EmoteBubbleType?, EmoteBubbleType?)

Action.ResetSpeech()

Action.CompleteIfNeedFull(NeedType, PersonLike)

Action.CompleteIfTimeUp(TimeSpan, bool, SkillType, float, bool)

Action.CompleteIfTimeUp(TimeSpan, TimeSpan, bool, SkillType, float, bool)

Action.GetRandomCompletionTime(TimeSpan, TimeSpan)

Action.CancelIfEmotional(params EmotionType[])

Action.Sit(Furniture, float, ActionSpot)

Action.GetChildren(bool)

Action.GetChild<T>(Guid, bool)

Action.PickUpAndGoTo(ActionInfo, ObjectCategory, ObjectCategory, bool, int?, IEnumerable<ActionType>)

Action.PickUpAndGoTo(ActionInfo, Func<Furniture, bool>, Func<Furniture, bool>, bool, int?, IEnumerable<ActionType>)

Action.GetFreeChair(PersonLike, Furniture)

Action.GetFreeChairs(PersonLike, Furniture, Func<Direction2, bool>)

Action.GetSeatCategory(PersonLike)

Action.FindAllFreePeople(PersonLike, ActionType, Map, Vector2?, float?, float?, bool, bool, bool, bool, Func<PersonLike, bool>)

Action.FindAllFreeFurniture(PersonLike, ObjectCategory, FurnitureType, bool, Map, Vector2?, float?, float?, bool, bool, Func<Furniture, bool>)

Action.FindAllFreeWalls<T>(PersonLike, Map, Vector2?, float?, float?, bool, bool)

Action.FindAllFreeGround(PersonLike, Map, Vector2?, float?, float?, bool, bool)

Action.FindFreeFurniture(PersonLike, ObjectCategory, FurnitureType, Map, Vector2?, float?, float?, bool, bool)

Action.FindAllActionObjects(PersonLike, ActionType, Map, Vector2?, float?, float?, bool, bool)

Action.FindValidActionObjects(PersonLike, ActionType, bool, Map, Vector2?, float?, float?, bool, bool, bool, bool, bool)

Action.GetRandomValidArguments(ActionType, ActionInfo, bool)

Action.GetTableSpot(Furniture, ActionSpot)

Action.InvokeForBoth(PersonLike, PersonLike, Action<PersonLike, PersonLike>)

Action.CanMultitask(Action, Action)

Action.IsInappropriate(ActionType, ActionInfo)

Action.IsLotContentVisible(Lot, PersonLike, Map, Vector2?, bool)

JsonTypeSafeGenericDataHolder.SetData<T>(string, T)

JsonTypeSafeGenericDataHolder.GetData<T>(string)

JsonTypeSafeGenericDataHolder.GetDataKeys()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Extensions.JsonCopy<T>(T)

Constructors

DebugAction(ActionType, ActionInfo)

Creates a new action with the given action information.

public DebugAction(ActionType type, ActionInfo info)

Parameters

type ActionType

The type for this action.

info ActionInfo

The information for this action.

Methods

CanMultitask(Action)

Return true on this method if this action can be multi-tasked along with the passed Action. To actually check this property, CanMultitask(Action, Action) should be used as it compares both objects. A multi-tasking is an action that is currently active along with another action. By default, multi-tasking is disallowed for any action.

public override Action.CanMultitaskResult CanMultitask(Action other)

Parameters

other Action

The action to multi-task with

Returns

Action.CanMultitaskResult

Whether this action can be multi-tasked

Create(string, ObjectCategory, Action<Action>, CanExecuteDelegate)

Creates type settings for a debug action that executes a simple Action with the given settings.

public static ActionType.TypeSettings Create(string name, ObjectCategory context, Action<Action> run, ActionType.CanExecuteDelegate canExecute = null)

Parameters

name string

The name.

context ObjectCategory

The context.

run Action<Action>

The action to execute when this debug action is run.

canExecute ActionType.CanExecuteDelegate

A ActionType.CanExecuteDelegate that determines whether the action can be started.

Returns

ActionType.TypeSettings

The created type settings.

Create(string, ObjectCategory, string, Func<ActionInfo, IEnumerable<object>>, CanExecuteDelegate)

Creates type settings for a debug action that executes a Cheats entry with the given settings.

public static ActionType.TypeSettings Create(string name, ObjectCategory context, string cheat, Func<ActionInfo, IEnumerable<object>> args = null, ActionType.CanExecuteDelegate canExecute = null)

Parameters

name string

The name.

context ObjectCategory

The context.

cheat string

The cheat to execute when this debug action is run.

args Func<ActionInfo, IEnumerable<object>>

The arguments to pass to the executed cheat when this debug action is run.

canExecute ActionType.CanExecuteDelegate

A ActionType.CanExecuteDelegate that determines whether the action can be started.

Returns

ActionType.TypeSettings

The created type settings.

Create(string, ObjectCategory, string, (Func<string> DisplayName, Func<ActionInfo, IEnumerable<object>> Args)[], CanExecuteDelegate)

Creates type settings for a debug action that executes a set of Cheats entry with the given potential arguments. Each argument is displayed as an ActionArgument when executing.

public static ActionType.TypeSettings Create(string name, ObjectCategory context, string cheat, (Func<string> DisplayName, Func<ActionInfo, IEnumerable<object>> Args)[] runsArgs, ActionType.CanExecuteDelegate canExecute = null)

Parameters

name string

The name.

context ObjectCategory

The context.

cheat string

The cheat to execute when this debug action is run.

runsArgs (Func<string> DisplayName, Func<ActionInfo, IEnumerable<object>> Args)[]

The choices of arguments to pass to the executed cheat when this debug action is run.

canExecute ActionType.CanExecuteDelegate

A ActionType.CanExecuteDelegate that determines whether the action can be started.

Returns

ActionType.TypeSettings

The created type settings.

Create(string, ObjectCategory, Type, CanExecuteDelegate)

Creates type settings for a debug action with the given settings.

public static ActionType.TypeSettings Create(string name, ObjectCategory context, Type constructedType, ActionType.CanExecuteDelegate canExecute = null)

Parameters

name string

The name.

context ObjectCategory

The context.

constructedType Type

The type of action to construct.

canExecute ActionType.CanExecuteDelegate

A ActionType.CanExecuteDelegate that determines whether the action can be started.

Returns

ActionType.TypeSettings

The created type settings.

Create(string, ObjectCategory, (Func<string> DisplayName, Action<Action> Action)[], CanExecuteDelegate)

Creates type settings for a debug action that executes a set of simple Action functions with the given settings. Each action function is displayed as an ActionArgument when executing.

public static ActionType.TypeSettings Create(string name, ObjectCategory context, (Func<string> DisplayName, Action<Action> Action)[] runs, ActionType.CanExecuteDelegate canExecute = null)

Parameters

name string

The name.

context ObjectCategory

The context.

runs (Func<string> DisplayName, Action<Action> Action)[]

The actions to execute when this debug action is run.

canExecute ActionType.CanExecuteDelegate

A ActionType.CanExecuteDelegate that determines whether the action can be started.

Returns

ActionType.TypeSettings

The created type settings.

Create(string, ObjectCategory, (Func<string> DisplayName, Func<ActionInfo, bool> Valid, Action<Action> Action)[], CanExecuteDelegate)

Creates type settings for a debug action that executes a set of simple Action functions with the given settings. Each action function is displayed as an ActionArgument when executing.

public static ActionType.TypeSettings Create(string name, ObjectCategory context, (Func<string> DisplayName, Func<ActionInfo, bool> Valid, Action<Action> Action)[] runs, ActionType.CanExecuteDelegate canExecute = null)

Parameters

name string

The name.

context ObjectCategory

The context.

runs (Func<string> DisplayName, Func<ActionInfo, bool> Valid, Action<Action> Action)[]

The actions to execute when this debug action is run.

canExecute ActionType.CanExecuteDelegate

A ActionType.CanExecuteDelegate that determines whether the action can be started.

Returns

ActionType.TypeSettings

The created type settings.

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 the default behavior of Interrupt(CompletionType) 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

Run()

Runs this debug action's behavior.

protected abstract void Run()