Raymond Maarloeve
Loading...
Searching...
No Matches
GoToSleepDecision Class Reference

Represents a decision for an NPC to go to sleep. More...

Public Member Functions

 GoToSleepDecision (GameObject buildingGO, NPC npc)
 Initializes a new instance of the GoToSleepDecision 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 is finished. Resets the NPC's thirst and hunger levels.
 
override bool ShouldFinish ()
 Determines whether the decision should finish based on the time of the day.
 
abstract void OnFinished ()
 Called when the decision is finished.
 
abstract bool ShouldFinish ()
 Determines whether the decision should finish.
 

Properties

override float StoppingDistance [get]
 Stopping distance for the NPC when approaching the building.
 
override bool NpcShouldDisappear [get]
 Whether the NPC should disappear after completing the decision.
 
override float WaitDuration [get]
 Duration the NPC should wait at the building.
 
override string PrettyName [get]
 Human-readable name of the decision.
 
- 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 go to sleep.

Constructor & Destructor Documentation

◆ GoToSleepDecision()

GoToSleepDecision.GoToSleepDecision ( GameObject  buildingGO,
NPC  npc 
)

Initializes a new instance of the GoToSleepDecision class.

Parameters
buildingGOThe GameObject representing the building the NPC will visit.
npcThe NPC making the decision.

Member Function Documentation

◆ OnFinished()

override void GoToSleepDecision.OnFinished ( )
protectedvirtual

Called when the decision is finished. Resets the NPC's thirst and hunger levels.

Implements VisitBuildingDecision.

◆ ShouldFinish()

override bool GoToSleepDecision.ShouldFinish ( )
protectedvirtual

Determines whether the decision should finish based on the time of the day.

Returns
true if the time of day is between 7:30 and 8:30 (dawn); otherwise, false.

Implements VisitBuildingDecision.

Property Documentation

◆ NpcShouldDisappear

override bool GoToSleepDecision.NpcShouldDisappear
getprotected

Whether the NPC should disappear after completing the decision.

◆ PrettyName

override string GoToSleepDecision.PrettyName
get

Human-readable name of the decision.

Implements IDecision.

◆ StoppingDistance

override float GoToSleepDecision.StoppingDistance
getprotected

Stopping distance for the NPC when approaching the building.

◆ WaitDuration

override float GoToSleepDecision.WaitDuration
getprotected

Duration the NPC should wait at the building.


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