Class TellPeopleToLeaveRoomAction

Namespace

TinyLife.Actions

Assembly

Tiny Life.dll

An action that causes the current Person to tell everyone else who is currently in the room to leave it. When initializing this action, a set of ExcludedPeople can optionally be specified.

public class TellPeopleToLeaveRoomAction : Action, IGenericDataHolder

Inheritance

object

JsonTypeSafeGenericDataHolder

Action

TellPeopleToLeaveRoomAction

Implements

IGenericDataHolder

Inherited Members

Action.Random

Action.InProgressTime

Action.FullyInProgress

Action.Type

Action.Info

Action.Id

Action.StartedAutomatically

Action.Parent

Action.Person

Action.ElapsedTime

Action.PlayerPromptOpen

Action.ForceResult

Action.Update(GameTime, TimeSpan, float)

Action.Validate(Person)

Action.TryForceResult(CompletionType, CanExecuteResult?, MapObject)

Action.CanMultitask(Action)

Action.CanStartNow()

Action.CanCancel(Action)

Action.GetNextAction(CompletionType)

Action.GetIconObject()

Action.CausesExtremelyFastSpeed()

Action.GetDisplayName()

Action.CanEnqueueConversation(Person, ActionType)

Action.GetProgress()

Action.OnChildCompleted(Action, CompletionType, bool)

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

Action.OpenYesNoPrompt(string, Action, Action, TextureRegion)

Action.OpenTextPrompt(string, Action<string>, Predicate<string>, TextField.Rule, string, TextureRegion)

Action.OpenChoicePrompt(ChoicePromptInfo)

Action.SpeakAlone(GameTime, float, EmoteCategory, SpeakStyle, int, float, float, float, float)

Action.ThinkAlone(GameTime, float, EmoteCategory, float, float, float, float, int)

Action.SpeakInConversation(Person, GameTime, float, EmoteCategory, SpeakStyle, EmoteCategory?, SpeakStyle?, int, float, float, float, float)

Action.ResetSpeech()

Action.CompleteIfNeedFull(NeedType, Person)

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

Action.CancelIfEmotional(params EmotionType[])

Action.Sit(Furniture, float, ActionSpot)

Action.GetChildren(bool)

Action.GetChild<T>(Guid, bool)

Action.PickUpAndGoTo(ActionInfo, ObjectCategory, ObjectCategory, bool)

Action.PickUpAndGoTo(ActionInfo, Func<Furniture, bool>, Func<Furniture, bool>, bool)

Action.GetFreeChair(Person, Furniture)

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

Action.GetSeatCategory(Person)

Action.FindAllFreePeople(Person, ActionType, Map, Vector2?, float?, float?, bool, bool, bool)

Action.FindAllFreeFurniture(Person, ObjectCategory, FurnitureType, bool, Map, Vector2?, float?, float?, bool, bool)

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

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

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

Action.FindAllActionObjects(Person, ActionType, Map, Vector2?)

Action.FindValidActionObjects(Person, ActionType, bool, Map, Vector2?, bool, bool)

Action.GetRandomValidArguments(ActionType, ActionInfo, bool)

Action.GetTableSpot(Furniture, ActionSpot)

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

Action.CanMultitask(Action, Action)

Action.IsInappropriate(ActionType, ActionInfo)

Action.IsLotContentVisible(Lot, Person, Map, Vector2?)

JsonTypeSafeGenericDataHolder.SetData(string, object)

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

TellPeopleToLeaveRoomAction(ActionInfo, params Guid[])

public TellPeopleToLeaveRoomAction(ActionInfo info, params Guid[] excludedPeople)

Parameters

info ActionInfo

excludedPeople Guid[]

Fields

ExcludedPeople

A list of Guid ids of Person objects that should not be asked to leave the room

[DataMember]
public readonly Guid[] ExcludedPeople

Field Value

Guid[]

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

TryToLeaveRoom(Room, Person)

Causes the given person to try to leave the current room, which is expected to be the room they are in. This method enqueues a GoHere action for a random location in an adjacent, connected room (GetConnectedRooms(Person)).

public static bool TryToLeaveRoom(Room currentRoom, Person person)

Parameters

currentRoom Room

The room to leave

person Person

The person that should leave the room

Returns

bool

false if there are no connected rooms to the given currentRoom, true otherwise