Defines a general-purpose context of the game. More...

Public Member Functions
bool	Check ()
	Evaluates the current context with the game's global state. More...

bool	Check (int tileX, int tileY)
	Evaluates the current context with the game's global state at a specific point in the world. More...

Public Attributes
TilePattern	TilePattern = null
	Tile 'pattern' that must exist at the location of the context. Leave null to skip. More...

ISet< NPCDefinition >	ActiveNPCs = null
	NPCs that must be active for this context to exist. Leave null to skip. More...

bool?	IsBoss = null
	Context is active when bosses are (true), or else only when they're not (false). Leave null to skip. More...

bool	IsDay = true
	Context can be active at day. More...

bool	IsNight = true
	Context can be active at night. More...

ISet< int >	MoonPhases = null
	Moon phases that the current context can apply during. Leave null to skip. More...

ISet< VanillaEventFlag >	Events = null
	Sets of vanilla events flags that must be set for the current context to apply. Leave null to skip. More...

ISet< string >	Progress = null
	Progress point of the game (via. GameInfoHelpers.GetVanillaProgress()) that must exist for the current context to apply. Leave null to skip. More...

Func< bool >	Custom = null
	Custom condition for the current context to apply. Leave null to skip. More...

ISet< Context >	AnyOthers = null
	Other contexts that can also apply or the current one to also apply. Leave null to skip. More...

Detailed Description

Defines a general-purpose context of the game.

Definition at line 15 of file Context.cs.

Member Function Documentation

◆ Check() [1/2]

bool HamstarHelpers.Classes.Context.Context.Check ( )

Evaluates the current context with the game's global state.

Returns

Definition at line 77 of file Context.cs.

◆ Check() [2/2]

bool HamstarHelpers.Classes.Context.Context.Check	(	int	tileX,
		int	tileY
	)

Evaluates the current context with the game's global state at a specific point in the world.

Parameters

tileX
tileY

Returns

Definition at line 87 of file Context.cs.

Member Data Documentation

◆ ActiveNPCs

ISet<NPCDefinition> HamstarHelpers.Classes.Context.Context.ActiveNPCs = null

NPCs that must be active for this context to exist. Leave null to skip.

Definition at line 26 of file Context.cs.

◆ AnyOthers

ISet<Context> HamstarHelpers.Classes.Context.Context.AnyOthers = null

Other contexts that can also apply or the current one to also apply. Leave null to skip.

Definition at line 67 of file Context.cs.

◆ Custom

Func<bool> HamstarHelpers.Classes.Context.Context.Custom = null

Custom condition for the current context to apply. Leave null to skip.

Definition at line 62 of file Context.cs.

◆ Events

ISet<VanillaEventFlag> HamstarHelpers.Classes.Context.Context.Events = null

Sets of vanilla events flags that must be set for the current context to apply. Leave null to skip.

Definition at line 51 of file Context.cs.

◆ IsBoss

bool? HamstarHelpers.Classes.Context.Context.IsBoss = null

Context is active when bosses are (true), or else only when they're not (false). Leave null to skip.

Definition at line 31 of file Context.cs.

◆ IsDay

bool HamstarHelpers.Classes.Context.Context.IsDay = true

Context can be active at day.

Definition at line 36 of file Context.cs.

◆ IsNight

bool HamstarHelpers.Classes.Context.Context.IsNight = true

Context can be active at night.

Definition at line 41 of file Context.cs.

◆ MoonPhases

ISet<int> HamstarHelpers.Classes.Context.Context.MoonPhases = null

Moon phases that the current context can apply during. Leave null to skip.

Definition at line 46 of file Context.cs.

◆ Progress

ISet<string> HamstarHelpers.Classes.Context.Context.Progress = null

Progress point of the game (via. GameInfoHelpers.GetVanillaProgress()) that must exist for the current context to apply. Leave null to skip.

Definition at line 57 of file Context.cs.

◆ TilePattern

TilePattern HamstarHelpers.Classes.Context.Context.TilePattern = null

Tile 'pattern' that must exist at the location of the context. Leave null to skip.

Definition at line 19 of file Context.cs.

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

Project/HamstarHelpers/Classes/Context/Context.cs

Public Member Functions

Public Attributes