Lemmings.LemmingRelationshipInfo Struct Reference

This is a struct that holds the data from a relationship. Intended to streamline visualization and manipulation from external menus. More...

Public Member Functions
void	RefreshDynamic ()
	Refreshes only the “dynamic” fields (Datum, Raw/Normalized/Curved, flags, status) based on the static data already stored in this struct.

Data Fields
LemmingRelationship	Relationship
	The original ScriptableObject defining this relationship.
string	Id
	Unique identifier for this relationship (e.g., "distance_leader_follower").
string	Description
	Human-readable description of the relationship's purpose or logic.
FamilyType	FamilyType
	Family structure type (Single, Couple, Throuple, Group).
LemmingHerdSnapshot	Herd
	Herd Snapshot referenced by this relationship.
Enum	Metric
	The enum value representing the selected metric.
string	MetricName
	Friendly name of the metric (e.g., "Distance").
string	MetricDescription
	Description of Metric.
LemmingRelationSetting	Settings
	Metric settings.
List<(string LemmingName, string Role)>	Members
	List of member names paired with their roles.
List< LemmingReference >	References
	List of members with full reference info for more secure access.
float	Min
	Raw minimum bound for normalization.
float	Max
	Raw maximum bound for normalization.
LemmingCurveType	CurveType
	Curve type used to shape the output.
AnimationCurve	CustomCurve
	Custom AnimationCurve when CurveType is Custom.
bool	UseCustomCurve
	True if using the custom curve.
object	RawValue
	Most recent raw value computed by LemmingRelation.
ValueType	ValueType
	Type of the raw value (Float, Vector3, Quaternion, etc.).
float	NormalizedValue
	Normalized [0,1] value after applying Min/Max bounds.
float	CurvedValue
	Value after passing through the selected curve.
RelationshipStatus	Status
	Logical status indicating Over, Under, InRange, or None.
bool	Over
	True if the raw value exceeds the Max bound.
bool	Under
	True if the raw value is below the Min bound.
bool	InRange
	True if the raw value lies within the Min-Max range.
float	AsAxis
	Converts Normalized value to -1 to 1 for easier input mapping and referencing relative values.
MetricSettingInfo	MetricSettings
	Optional per-metric setting definitions (e.g., threshold, axis choice).
MetricOptionInfo	MetricOptions
	Optional grouped metric options for advanced UI scenarios.
LemmingRelation	Relation
	The underlying struct wrapper for computations.
ILemmingConverter	Converter
	Converter instance used to translate raw data into normalized/typed values.
LemmingDatum	Datum
	The LemmingDatum representing the last computed datum.

Detailed Description

This is a struct that holds the data from a relationship. Intended to streamline visualization and manipulation from external menus.

Data container carrying all relevant information about a LemmingRelationship for UI binding, serialization, or ad-hoc inspection.

---

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

• Assets/Lemmings/Scripts/Namespace/LemmingUtilities.cs