WarmHandsDecision Class Reference

Represents a decision for an NPC to warm their hands near a fire or hearth. More...

Public Member Functions
	WarmHandsDecision (GameObject buildingGO, NPC npc)
	Initializes a new instance of the WarmHandsDecision 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 waiting near the fire).
override bool	ShouldFinish ()
	Determines if the decision should finish prematurely. Return false to let it complete naturally after WaitDuration.
abstract void	OnFinished ()
	Called when the decision is finished.
abstract bool	ShouldFinish ()
	Determines whether the decision should finish.

Properties
override float	StoppingDistance [get]
	How close the NPC should stop near the fire. A small distance makes them stand naturally near the heat source.
override bool	NpcShouldDisappear [get]
	Whether the NPC should disappear after reaching the target. Warming hands is done outside or in public — keep the NPC visible.
override float	WaitDuration [get]
	Duration of time the NPC spends warming hands near the fire.
override string	PrettyName [get]
	Human-readable description of the decision, used for speech bubbles or 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 warm their hands near a fire or hearth.

Constructor & Destructor Documentation

WarmHandsDecision()

WarmHandsDecision.WarmHandsDecision	(	GameObject	buildingGO,
		NPC	npc
	)

Initializes a new instance of the WarmHandsDecision class.

Parameters

buildingGO	The GameObject representing the fire or hearth.
npc	The NPC performing the decision.

Member Function Documentation

OnFinished()

override void WarmHandsDecision.OnFinished ( )

protectedvirtual

Called when the decision finishes (after waiting near the fire).

Implements VisitBuildingDecision.

ShouldFinish()

override bool WarmHandsDecision.ShouldFinish ( )

protectedvirtual

Determines if the decision should finish prematurely. Return false to let it complete naturally after WaitDuration.

Returns

False — the decision ends only when WaitDuration elapses.

Implements VisitBuildingDecision.

Property Documentation

NpcShouldDisappear

override bool WarmHandsDecision.NpcShouldDisappear

getprotected

Whether the NPC should disappear after reaching the target. Warming hands is done outside or in public — keep the NPC visible.

PrettyName

override string WarmHandsDecision.PrettyName

get

Human-readable description of the decision, used for speech bubbles or logs.

Implements IDecision.

StoppingDistance

override float WarmHandsDecision.StoppingDistance

getprotected

How close the NPC should stop near the fire. A small distance makes them stand naturally near the heat source.

WaitDuration

override float WarmHandsDecision.WaitDuration

getprotected

Duration of time the NPC spends warming hands near the fire.

---

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

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