SweepYardDecision Class Reference

Represents a decision for an NPC to sweep the yard or area around a building. More...

Public Member Functions
	SweepYardDecision (GameObject buildingGO, NPC npc)
	Initializes a new instance of the SweepYardDecision class.
Public Member Functions inherited from VisitBuildingDecision
	VisitBuildingDecision (GameObject buildingGO, NPC npc)
	Initializes a new instance of the VisitBuildingDecision class.
bool	Tick ()
	Executes the decision logic each frame.
void	Start ()
	Starts the decision by setting the NPC's destination and stopping distance.
void	Finish ()
	Finishes the decision and restores the NPC's state if necessary.
string	DebugInfo ()
	Provides debug information about the decision.
void	Start ()
	Initializes the decision action. Implementation should begin execution of the decision logic.
void	Finish ()
	Finalizes the decision action. Implementation should clean up any resources or state related to the decision.
bool	Tick ()
	Executes the decision logic and determines the outcome.
string	DebugInfo ()
	Provides debugging information for the decision.

Protected Member Functions
override void	OnFinished ()
	Called when the decision finishes (after the sweeping duration).
override bool	ShouldFinish ()
	Determines whether the decision should end prematurely. Returns false so the NPC always waits the full duration.
abstract void	OnFinished ()
	Called when the decision is finished.
abstract bool	ShouldFinish ()
	Determines whether the decision should finish.

Properties
override float	StoppingDistance [get]
	The stopping distance for the NPC when approaching the sweeping spot.
override bool	NpcShouldDisappear [get]
	Whether the NPC should disappear after reaching the target. Sweeping the yard is an outdoor action, so the NPC should stay visible.
override float	WaitDuration [get]
	Duration of time the NPC spends sweeping the yard.
override string	PrettyName [get]
	Human-readable name used for speech bubbles and logs.
Properties inherited from VisitBuildingDecision
bool	reachedBuilding [get]
	Indicates whether the NPC has reached the building.
abstract float	WaitDuration [get]
	The duration the NPC should wait after reaching the building.
abstract float	StoppingDistance [get]
	The stopping distance for the NPC when approaching the building.
abstract bool	NpcShouldDisappear [get]
	Indicates whether the NPC should disappear upon reaching the building.
abstract string	PrettyName [get]
	Gets the human-readable name of the decision.
Properties inherited from IDecision
string	PrettyName [get]
	Gets the human-readable description of the decision.

Additional Inherited Members
Protected Attributes inherited from VisitBuildingDecision
NPC	npc
	The NPC associated with this decision.

Detailed Description

Represents a decision for an NPC to sweep the yard or area around a building.

Constructor & Destructor Documentation

SweepYardDecision()

SweepYardDecision.SweepYardDecision	(	GameObject	buildingGO,
		NPC	npc
	)

Initializes a new instance of the SweepYardDecision class.

Parameters

buildingGO	The GameObject representing the house, tavern, or yard area.
npc	The NPC performing the decision.

Member Function Documentation

OnFinished()

override void SweepYardDecision.OnFinished ( )

protectedvirtual

Called when the decision finishes (after the sweeping duration).

Implements VisitBuildingDecision.

ShouldFinish()

override bool SweepYardDecision.ShouldFinish ( )

protectedvirtual

Determines whether the decision should end prematurely. Returns false so the NPC always waits the full duration.

Returns

False — the decision completes only after WaitDuration elapses.

Implements VisitBuildingDecision.

Property Documentation

NpcShouldDisappear

override bool SweepYardDecision.NpcShouldDisappear

getprotected

Whether the NPC should disappear after reaching the target. Sweeping the yard is an outdoor action, so the NPC should stay visible.

PrettyName

override string SweepYardDecision.PrettyName

get

Human-readable name used for speech bubbles and logs.

Implements IDecision.

StoppingDistance

override float SweepYardDecision.StoppingDistance

getprotected

The stopping distance for the NPC when approaching the sweeping spot.

WaitDuration

override float SweepYardDecision.WaitDuration

getprotected

Duration of time the NPC spends sweeping the yard.

---

The documentation for this class was generated from the following file:

• RaymondMaarloeve/Assets/Scripts/NPC/DecisionSystem/Decisions/SweepYardDecision.cs