Lemmings.LemmingHerdSnapshot Class Reference

A fixed, read-only snapshot of a Lemming Herd configuration. Stores Lemming names, confidence values, and their associated GameObjects for runtime reference. Also generates a unique enum per snapshot for consistent name referencing. More...

Inherits ScriptableObject.

Public Member Functions
GameObject	FindLemming (string name)
	Finds a Lemming Entry's GameObject in the herd by its assigned name.
LemmingReference?	FindReference (string name)
	Finds a Lemming Entry in the herd by its assigned name.
bool	TryGetReference (string name, out LemmingReference reference)
	This is a check to confirm the reference exists within the dictionary.
void	RefreshLookup ()
	This refreshes the dictionary with the member data.

Data Fields
string	generatedEnumPath
	This is the enum path for accessing the available Lemming Options.
List< LemmingReference >	members = new List<LemmingReference>()
	The list of all lemmings in this herd snapshot.

Properties
IEnumerable< GameObject >	AllObjects [get]
	Gets all GameObjects in this snapshot.
IEnumerable< string >	AllNames [get]
	Gets all lemming names in this snapshot.

Private Attributes
Dictionary< string, LemmingReference >	memberLookup
	This dictionary is meant to hold reference data more securely.

Detailed Description

A fixed, read-only snapshot of a Lemming Herd configuration. Stores Lemming names, confidence values, and their associated GameObjects for runtime reference. Also generates a unique enum per snapshot for consistent name referencing.

Member Function Documentation

FindLemming()

GameObject Lemmings.LemmingHerdSnapshot.FindLemming

(

string

name

)

Finds a Lemming Entry's GameObject in the herd by its assigned name.

Parameters

name	The lemming name to search for.

Returns

The corresponding GameObject, or null if not found.

FindReference()

LemmingReference? Lemmings.LemmingHerdSnapshot.FindReference ( string name )

inline

Finds a Lemming Entry in the herd by its assigned name.

Parameters

name	The lemming name to search for.

Returns

The corresponding Reference, or null if not found.

TryGetReference()

bool Lemmings.LemmingHerdSnapshot.TryGetReference ( string name, out LemmingReference reference )

inline

This is a check to confirm the reference exists within the dictionary.

Parameters

name	The name of the Lemming being sought
reference	The reference entry associated with that name

Returns

---

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

• Assets/Lemmings/Scripts/ScriptableObjects/LemmingHerdSnapshot.cs