Lemmings.LemmingMetricMetadata Class Reference

Provides descriptions and optional editor UI for Lemming metric enum values. Helps clarify affordances and behaviors for user-facing tools. More...

Static Public Member Functions
static string	GetDescription (Enum metric)
	Returns a descriptive string for the given metric enum.
static string	ExampleDescription ()

Static Private Attributes
static string	SinglePosition
static string	SingleRotation
static string	SingleMovement
static string	SingleTrigger
static string	CouplePosition
static string	CoupleRotation
static string	CoupleMovement
static string	CoupleTrigger
static string	CoupleDistance
static string	CoupleDifference
static string	ThrouplePosition
static string	ThroupleRotation
static string	ThroupleMovement
static string	ThroupleTrigger
static string	ThroupleDistance
static string	ThroupleRotationAroundAxis
static string	ThroupleDensity
static string	ThroupleAngle
static string	ThroupleSize
static string	GroupPosition
static string	GroupRotation
static string	GroupMovement
static string	GroupTrigger
static string	GroupRotationAroundAxis
static string	GroupDensity
static string	GroupSize

Detailed Description

Provides descriptions and optional editor UI for Lemming metric enum values. Helps clarify affordances and behaviors for user-facing tools.

Field Documentation

CoupleDifference

string Lemmings.LemmingMetricMetadata.CoupleDifference

staticprivate

Initial value:

=
            "Returns the direction from one Lemming to the other. "
            + "You can look at just one axis or get a total distance instead. "
            + "Use this when you care about where one member is in relation to the other."

CoupleDistance

string Lemmings.LemmingMetricMetadata.CoupleDistance

staticprivate

Initial value:

=
            "Measures how far apart the two Lemmings are. "
            + "You can switch between meters, feet, inches, or centimeters. "
            + "Great for things like closeness, spacing, or proximity rules."

CoupleMovement

string Lemmings.LemmingMetricMetadata.CoupleMovement

staticprivate

Initial value:

=
            "Shows how the two Lemmings are moving together. "
            + "You can use it as a direction, a speed, or just focus on one axis. "
            + "Helpful for driving effects based on how the pair moves."

CouplePosition

string Lemmings.LemmingMetricMetadata.CouplePosition

staticprivate

Initial value:

=
            "Finds the spot exactly between the two Lemmings. "
            + "You can narrow it down to just X, Y, or Z if needed. "
            + "Good for tracking where a pair is centered in space."

CoupleRotation

string Lemmings.LemmingMetricMetadata.CoupleRotation

staticprivate

Initial value:

=
            "Figures out which way the pair is facing, from the follower toward the leader. "
            + "You can flip the direction or change how 'up' is defined. "
            + "Useful when you want something to aim or turn based on the pair’s layout."

CoupleTrigger

string Lemmings.LemmingMetricMetadata.CoupleTrigger

staticprivate

Initial value:

=
            "Returns true when the Lemming’s trigger proxy is active. "
            + "This is often used for detecting collisions, proximity, or interaction events. "
            + "Only works if a proxy is set up and properly configured."

GroupDensity

string Lemmings.LemmingMetricMetadata.GroupDensity

staticprivate

Initial value:

=
            "Tells you how tightly or loosely packed the group is. "
            + "Based on how far members are from the group’s center. "
            + "Helpful for detecting clustering or spreading behavior."

GroupMovement

string Lemmings.LemmingMetricMetadata.GroupMovement

staticprivate

Initial value:

=
            "Shows how the group is moving together. "
            + "You can get a direction, speed, or even how much they’re moving toward or away from their center. "
            + "Use this for effects that respond to overall group motion."

GroupPosition

string Lemmings.LemmingMetricMetadata.GroupPosition

staticprivate

Initial value:

=
            "Finds the average position of all the Lemmings in the group. "
            + "You can pull out just one axis if you like. "
            + "Useful for tracking where the whole group is centered."

GroupRotation

string Lemmings.LemmingMetricMetadata.GroupRotation

staticprivate

Initial value:

=
            "Figures out the overall direction the group is moving toward. "
            + "This is based on the average velocity of all members. "
            + "Helpful for aligning other objects to the group’s flow or movement."

GroupRotationAroundAxis

string Lemmings.LemmingMetricMetadata.GroupRotationAroundAxis

staticprivate

Initial value:

=
            "Checks how much the group’s movement is turning or rotating around a chosen axis. "
            + "You can define a reference direction and control the measurement settings. "
            + "Useful for spotting drifts, spirals, or coordinated turns."

GroupSize

string Lemmings.LemmingMetricMetadata.GroupSize

staticprivate

Initial value:

=
            "Returns how large the group is — either the bounding box size or the radius from center. "
            + "You can focus on one axis or get the full 3D size. "
            + "Good for tracking formation width or spacing."

GroupTrigger

string Lemmings.LemmingMetricMetadata.GroupTrigger

staticprivate

Initial value:

=
            "Returns true when the Lemming’s trigger proxy is active. "
            + "This is often used for detecting collisions, proximity, or interaction events. "
            + "Only works if a proxy is set up and properly configured."

SingleMovement

string Lemmings.LemmingMetricMetadata.SingleMovement

staticprivate

Initial value:

=
            "Measures how fast and in what direction the Lemming is moving. "
            + "You can return the full velocity, limit it to a single axis, or simplify it to just speed. "
            + "Great for detecting motion or feeding movement into other systems."

SinglePosition

string Lemmings.LemmingMetricMetadata.SinglePosition

staticprivate

Initial value:

=
            "Returns the world position of the Lemming. "
            + "You can filter the output to a single axis (X, Y, or Z) if needed. "
            + "Use this when you care about where a Lemming is in space."

SingleRotation

string Lemmings.LemmingMetricMetadata.SingleRotation

staticprivate

Initial value:

=
            "Returns the rotation of the Lemming as a Quaternion. "
            + "If used with gaze settings, this can act as a trigger when the Lemming looks at something. "
            + "Choose this if you're working with orientation, facing, or view direction."

SingleTrigger

string Lemmings.LemmingMetricMetadata.SingleTrigger

staticprivate

Initial value:

=
            "Returns true when the Lemming’s trigger proxy is active. "
            + "This is often used for detecting collisions, proximity, or interaction events. "
            + "Only works if a proxy is set up and properly configured."

ThroupleAngle

string Lemmings.LemmingMetricMetadata.ThroupleAngle

staticprivate

Initial value:

=
            "Measures the angle at each point in the triangle made by the group. "
            + "You get three values: the X value is the angle at the Leader. "
            + "the Y value is the angle at the Follower, and the Z value is the angle at the Third. "
            + "Good for understanding shape, tension, or how the group is arranged."

ThroupleDensity

string Lemmings.LemmingMetricMetadata.ThroupleDensity

staticprivate

Initial value:

=
            "Tells you how tightly packed the group is. "
            + "This is based on how far each member is from the group’s center. "
            + "Use it to track group cohesion or spreading out."

ThroupleDistance

string Lemmings.LemmingMetricMetadata.ThroupleDistance

staticprivate

Initial value:

=
            "Measures the distances between each member of the group. "
            + "You can pick one pair or get the average of all three. "
            + "Helpful for gauging how tightly or loosely the group is spread out."

ThroupleMovement

string Lemmings.LemmingMetricMetadata.ThroupleMovement

staticprivate

Initial value:

=
            "Shows how the group of three is moving as a whole. "
            + "You can get a direction, a speed, or a single axis. "
            + "Useful for driving animations or effects tied to motion."

ThrouplePosition

string Lemmings.LemmingMetricMetadata.ThrouplePosition

staticprivate

Initial value:

=
            "Finds the center point between all three Lemmings. "
            + "You can pull just one axis or use the full 3D position. "
            + "Good for tracking where the group is gathered."

ThroupleRotation

string Lemmings.LemmingMetricMetadata.ThroupleRotation

staticprivate

Initial value:

=
            "Figures out which way the group is facing, based on the layout of all three. "
            + "You can choose which member the rotation is based on, or flip the direction. "
            + "Use this to align things to the group’s overall direction."

ThroupleRotationAroundAxis

string Lemmings.LemmingMetricMetadata.ThroupleRotationAroundAxis

staticprivate

Initial value:

=
            "Checks how much the group has twisted or rotated around a chosen direction. "
            + "You can set which axis and which member layout to use. "
            + "Useful for detecting leaning, turning, or circling behaviors."

ThroupleSize

string Lemmings.LemmingMetricMetadata.ThroupleSize

staticprivate

Initial value:

=
            "Returns how large the group is — either the full bounding box or the distance from center. "
            + "You can pull one axis or use the full 3D size. "
            + "Great for understanding spread or formation shape."

ThroupleTrigger

string Lemmings.LemmingMetricMetadata.ThroupleTrigger

staticprivate

Initial value:

=
            "Returns true when the Lemming’s trigger proxy is active. "
            + "This is often used for detecting collisions, proximity, or interaction events. "
            + "Only works if a proxy is set up and properly configured."

---

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

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