Lemmings.LemmingRelationSetting Class Reference

This is a class with numerous optional variables. This can be used to pass along settings for specific methods when appropriate. This is meant to be extensible for holding any setting options. More...

Public Member Functions
List< MetricSettingInfo >	ToMetricSettingsList (FamilyType family, Enum metric)
override string	ToString ()

Data Fields
LemmingRelationshipProxy	proxy
	Proxy used for trigger and gaze interactions.
DistanceOptions	distanceOptions
	Used to select a distance calculation choice for throuples.
DistanceUnit	distanceUnit
	Used to set the distance with unit conversions, such as inches or centimeters.
bool	relativeToObject
	This is used if a value is to be determined relative to some other game object, such as the main camera or the player.
GameObject	objectToReference
	This is an object field which can be used to select a game object to be referenced..
bool	useGazeFromProxy
	This is to set the relationship to trigger if the proxy's forward vector is landing on a tagged object.
bool	magnitudeOnly
	This is set true to receive velocity information as a float.
bool	directionOnly
	This is set true to receive velocity information normalized to provide directional information only.
bool	relativeToMembers
	This is set true to receive velocity indicating how fast members are moving towards each other or away from each other.
AxisSelection	axisSelection
	This is enum is used to select which axis to use as a reference for a signed angle calculation. used when you want rotation to act as a trigger but want to avoid quaternions.
bool	invert
	This is a boolean to set if the value or direction should be inverted.
AxisSelectionThrouple	axisSelectionThrouple
	This is enum is used to select which axis to use as a reference for a signed angle calculation. used when you want rotation to act as a trigger but want to avoid quaternions. Throuples have unique options relative to their members.
DensityMethod	densityMethod
	This is enum is used to select which method to use for calculating density.
SizeMethod	sizeMethod
	This is enum is used to select which method to use for calculating size.
bool	useSingleAxis
	This is set to true if you want data to come in as a single axis, such as the Y axis for position.
SingleAxis	singleAxis
	This is for selecting a single axis to isolate from a vector 3.
Vector3	referenceVector
	This is for holding a custom reference vector.
Vector3	rotationAxis
	This is for holding a custom rotation reference vector.
float	threshold
	This is for setting a threshold for establishing a potential boolean setting.

Properties
bool	IsBool [get]
bool	IsFloat [get]
bool	IsVector3 [get]

Detailed Description

This is a class with numerous optional variables. This can be used to pass along settings for specific methods when appropriate. This is meant to be extensible for holding any setting options.

Any new variable added to this need to established as being allowed as null. You can do this with the ? after the type or with the [CanBeNull] [ItemCanBeNull] attributes

Example Usage: var setting = new LemmingRelationSetting { referenceVector = Vector3.right }; var result = relationship.MyRelation.Evaluate(context, setting);

---

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

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