Lemmings.LemmingSettingDescriptions Class Reference

Static Public Member Functions
static string	GetDescription (string fieldName)
	Gets a description for a known Lemming setting by field name.

Static Private Attributes
static string	Invert
static string	UseSingleAxis
static string	SingleAxis
static string	ReferenceVector
static string	RotationAxis
static string	Threshold
static string	RelativeToObject
static string	ObjectToReference
static string	RelativeToMembers
static string	MagnitudeOnly
static string	DirectionOnly
static string	DistanceOptions
static string	DistanceUnit
static string	AxisSelection
static string	AxisSelectionThrouple
static string	DensityMethod
static string	SizeMethod
static string	Proxy
static string	UseGazeFromProxy
static string	AddTags
static string	TagsToAdd

Detailed Description

Provides plainspoken descriptions for LemmingRelationSetting fields. These are used to guide users in UI or tooltips when configuring metrics.

Member Function Documentation

GetDescription()

string Lemmings.LemmingSettingDescriptions.GetDescription ( string fieldName )

inlinestatic

Gets a description for a known Lemming setting by field name.

Parameters

fieldName

The field name in LemmingRelationSetting (e.g. "invert").

Returns

The matching description string, or null if not found.

Field Documentation

AddTags

string Lemmings.LemmingSettingDescriptions.AddTags

staticprivate

Initial value:

=
            "Allow custom tags to define what the proxy can interact with."

AxisSelection

string Lemmings.LemmingSettingDescriptions.AxisSelection

staticprivate

Initial value:

=
            "Choose how to define the 'up' direction or comparison axis."

AxisSelectionThrouple

string Lemmings.LemmingSettingDescriptions.AxisSelectionThrouple

staticprivate

Initial value:

=
            "Select how to define the axis based on group layout."

DensityMethod

string Lemmings.LemmingSettingDescriptions.DensityMethod

staticprivate

Initial value:

=
            "Choose how to calculate how tightly packed the group is."

DirectionOnly

string Lemmings.LemmingSettingDescriptions.DirectionOnly

staticprivate

Initial value:

=
            "Only return the direction of movement, not the speed."

DistanceOptions

string Lemmings.LemmingSettingDescriptions.DistanceOptions

staticprivate

Initial value:

=
            "Choose which pair of members to measure distance between."

DistanceUnit

string Lemmings.LemmingSettingDescriptions.DistanceUnit

staticprivate

Initial value:

=
            "Select the unit to use (meters, feet, etc.)."

Invert

string Lemmings.LemmingSettingDescriptions.Invert

staticprivate

Initial value:

=
            "Flip the direction or sign of the result."

MagnitudeOnly

string Lemmings.LemmingSettingDescriptions.MagnitudeOnly

staticprivate

Initial value:

=
            "Only return the speed, without direction."

ObjectToReference

string Lemmings.LemmingSettingDescriptions.ObjectToReference

staticprivate

Initial value:

=
            "The GameObject used as a reference for relative comparisons."

Proxy

string Lemmings.LemmingSettingDescriptions.Proxy

staticprivate

Initial value:

=
            "Used to detect triggers or gaze-based events."

ReferenceVector

string Lemmings.LemmingSettingDescriptions.ReferenceVector

staticprivate

Initial value:

=
            "Use this vector as a reference direction for comparison."

RelativeToMembers

string Lemmings.LemmingSettingDescriptions.RelativeToMembers

staticprivate

Initial value:

=
            "Measure how members are moving toward or away from each other."

RelativeToObject

string Lemmings.LemmingSettingDescriptions.RelativeToObject

staticprivate

Initial value:

=
            "Measure relative to another GameObject (like the camera)."

RotationAxis

string Lemmings.LemmingSettingDescriptions.RotationAxis

staticprivate

Initial value:

=
            "The axis used when measuring angles or rotations."

SingleAxis

string Lemmings.LemmingSettingDescriptions.SingleAxis

staticprivate

Initial value:

=
            "Choose which axis to use when isolating a value."

SizeMethod

string Lemmings.LemmingSettingDescriptions.SizeMethod

staticprivate

Initial value:

=
            "Select how to measure the group’s size (bounding box or radius)."

TagsToAdd

string Lemmings.LemmingSettingDescriptions.TagsToAdd

staticprivate

Initial value:

=
            "List of tags this proxy will respond to."

Threshold

string Lemmings.LemmingSettingDescriptions.Threshold

staticprivate

Initial value:

=
            "The minimum value required to trigger a true result."

UseGazeFromProxy

string Lemmings.LemmingSettingDescriptions.UseGazeFromProxy

staticprivate

Initial value:

=
            "Turn on when the Lemming is looking at a valid target."

UseSingleAxis

string Lemmings.LemmingSettingDescriptions.UseSingleAxis

staticprivate

Initial value:

=
            "Only return the value from one axis (X, Y, or Z)."

---

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

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