Class ParameterUtility

Namespace

TMPEffects

Assembly

TMPEffects.dll

Utility class for easy parameter handling.

public static class ParameterUtility

Inheritance

object

ParameterUtility

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Fields

AmplitudeAliases

public static readonly string[] AmplitudeAliases

Field Value

string[]

AnchorKeywords

public static readonly ReadOnlyDictionary<string, Vector2> AnchorKeywords

Field Value

ReadOnlyDictionary<string, Vector2>

BuiltInFloatKeywords

A variety of built-in keywords for float parameters.

public static readonly ReadOnlyDictionary<string, float> BuiltInFloatKeywords

Field Value

ReadOnlyDictionary<string, float>

BuiltInVector2Keywords

A variety of built-in keywords for Vector2 parameters.

public static readonly ReadOnlyDictionary<string, Vector2> BuiltInVector2Keywords

Field Value

ReadOnlyDictionary<string, Vector2>

BuiltInVector3Keywords

A variety of built-in keywords for Vector3 parameters.

public static readonly ReadOnlyDictionary<string, Vector3> BuiltInVector3Keywords

Field Value

ReadOnlyDictionary<string, Vector3>

CurveAliases

public static readonly string[] CurveAliases

Field Value

string[]

FrequencyAliases

public static readonly string[] FrequencyAliases

Field Value

string[]

PivotAliases

public static readonly string[] PivotAliases

Field Value

string[]

RadiusAliases

public static readonly string[] RadiusAliases

Field Value

string[]

SpeedAliases

public static readonly string[] SpeedAliases

Field Value

string[]

WaveOffsetAliases

public static readonly string[] WaveOffsetAliases

Field Value

string[]

Methods

CreateWave(Wave, WaveParameters)

public static AnimationUtility.Wave CreateWave(AnimationUtility.Wave wave, ParameterUtility.WaveParameters wp)

Parameters

wave AnimationUtility.Wave

wp ParameterUtility.WaveParameters

Returns

AnimationUtility.Wave

GetWaveParameters(IDictionary<string, string>, string, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool)

public static ParameterUtility.WaveParameters GetWaveParameters(IDictionary<string, string> parameters, string prefix = "", bool upwardCurve = true, bool downwardCurve = true, bool upPeriod = true, bool downPeriod = true, bool crestWait = true, bool troughWait = true, bool waveVelocity = true, bool waveLength = true, bool waveUniformity = true, bool amplitude = true)

Parameters

parameters IDictionary<string, string>

prefix string

upwardCurve bool

downwardCurve bool

upPeriod bool

downPeriod bool

crestWait bool

troughWait bool

waveVelocity bool

waveLength bool

waveUniformity bool

amplitude bool

Returns

ParameterUtility.WaveParameters

HasAnchorParameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type Anchor (=> can no be converted to Anchor).

public static bool HasAnchorParameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type Anchor, false otherwise.

HasAnimCurveParameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type AnimationCurve (=> can no be converted to AnimationCurve).

public static bool HasAnimCurveParameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type AnimationCurve, false otherwise.

HasArrayParameter<T>(IDictionary<string, string>, ParseDelegate<string, T, IDictionary<string, T>, bool>, string, params string[])

public static bool HasArrayParameter<T>(IDictionary<string, string> parameters, ParameterUtility.ParseDelegate<string, T, IDictionary<string, T>, bool> func, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

func ParameterUtility.ParseDelegate<string, T, IDictionary<string, T>, bool>

name string

aliases string[]

Returns

bool

Type Parameters

T

HasBoolParameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type bool (=> can no be converted to bool).

public static bool HasBoolParameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type bool, false otherwise.

HasColorParameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type Color (=> can no be converted to Color).

public static bool HasColorParameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type Color, false otherwise.

HasFloatParameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type float (=> can be converted to float).

public static bool HasFloatParameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type float, false otherwise.

HasIntParameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type int (=> can no be converted to int).

public static bool HasIntParameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type int, false otherwise.

HasNonAnchorParameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is not of type Anchor (=> can not be converted to Anchor).

public static bool HasNonAnchorParameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is not of type Anchor, false otherwise.

HasNonAnimCurveParameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is not of type AnimationCurve (=> can not be converted to AnimationCurve).

public static bool HasNonAnimCurveParameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is not of type AnimationCurve, false otherwise.

HasNonArrayParameter<T>(IDictionary<string, string>, ParseDelegate<string, T, IDictionary<string, T>, bool>, string, params string[])

public static bool HasNonArrayParameter<T>(IDictionary<string, string> parameters, ParameterUtility.ParseDelegate<string, T, IDictionary<string, T>, bool> func, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

func ParameterUtility.ParseDelegate<string, T, IDictionary<string, T>, bool>

name string

aliases string[]

Returns

bool

Type Parameters

T

HasNonBoolParameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is not of type bool (=> can not be converted to bool).

public static bool HasNonBoolParameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is not of type bool, false otherwise.

HasNonColorParameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is not of type Color (=> can not be converted to Color).

public static bool HasNonColorParameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is not of type Color, false otherwise.

HasNonFloatParameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is not of type float (=> can not be converted to float).

public static bool HasNonFloatParameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is not of type float, false otherwise.

HasNonIntParameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is not of type int (=> can not be converted to int).

public static bool HasNonIntParameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is not of type int, false otherwise.

HasNonTypedVector2Parameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is not of type TypedVector2 (=> can not be converted to TypedVector2).

public static bool HasNonTypedVector2Parameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is not of type TypedVector2, false otherwise.

HasNonTypedVector3Parameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is not of type TypedVector3 (=> can not be converted to TypedVector3).

public static bool HasNonTypedVector3Parameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is not of type TypedVector3, false otherwise.

HasNonVector2OffsetParameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is not of type Vector2Offset (=> can not be converted to Vector2Offset).

public static bool HasNonVector2OffsetParameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is not of type Vector2Offset, false otherwise.

HasNonVector2Parameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is not of type Vector2 (=> can not be converted to Vector2).

public static bool HasNonVector2Parameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is not of type Vector2, false otherwise.

HasNonVector3OffsetParameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is not of type Vector3Offset (=> can not be converted to Vector3Offset).

public static bool HasNonVector3OffsetParameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is not of type Vector3Offset, false otherwise.

HasNonVector3Parameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is not of type Vector3 (=> can not be converted to Vector3).

public static bool HasNonVector3Parameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is not of type Vector3, false otherwise.

HasNonWaveOffsetParameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is not of type WaveOffsetType (=> can not be converted to WaveOffsetType).

public static bool HasNonWaveOffsetParameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is not of type WaveOffsetType, false otherwise.

HasTypedVector2Parameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type TypedVector2 (=> can no be converted to TypedVector2).

public static bool HasTypedVector2Parameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type TypedVector2, false otherwise.

HasTypedVector3Parameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type TypedVector3 (=> can no be converted to TypedVector3).

public static bool HasTypedVector3Parameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type TypedVector3, false otherwise.

HasVector2OffsetParameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type Vector2Offset (=> can no be converted to Vector2Offset).

public static bool HasVector2OffsetParameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type Vector2Offset, false otherwise.

HasVector2Parameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type Vector2 (=> can no be converted to Vector2).

public static bool HasVector2Parameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type Vector2, false otherwise.

HasVector3OffsetParameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type Vector3Offset (=> can no be converted to Vector3Offset).

public static bool HasVector3OffsetParameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type Vector3Offset, false otherwise.

HasVector3Parameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type Vector3 (=> can no be converted to Vector3).

public static bool HasVector3Parameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type Vector3, false otherwise.

HasWaveOffsetParameter(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type WaveOffsetType (=> can no be converted to WaveOffsetType).

public static bool HasWaveOffsetParameter(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type WaveOffsetType, false otherwise.

ParameterDefined(IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases.
A parameter is well-defined if there is exactly one of the given aliases (including the name) present in the parameters.

public static bool ParameterDefined(IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if the parameter is well-defined, false otherwise.

TryGetAnchorParameter(out Vector2, IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type Anchor (=> can be converted to Anchor).

public static bool TryGetAnchorParameter(out Vector2 value, IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

value Vector2

Set to the value of the parameter if successful.

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type Anchor, false otherwise.

TryGetAnimCurveParameter(out AnimationCurve, IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type AnimationCurve (=> can be converted to AnimationCurve).

public static bool TryGetAnimCurveParameter(out AnimationCurve value, IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

value AnimationCurve

Set to the value of the parameter if successful.

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type AnimationCurve, false otherwise.

TryGetArrayParameter<T>(out T[], IDictionary<string, string>, ParseDelegate<string, T, IDictionary<string, T>, bool>, string, params string[])

public static bool TryGetArrayParameter<T>(out T[] value, IDictionary<string, string> parameters, ParameterUtility.ParseDelegate<string, T, IDictionary<string, T>, bool> func, string name, params string[] aliases)

Parameters

value T[]

parameters IDictionary<string, string>

func ParameterUtility.ParseDelegate<string, T, IDictionary<string, T>, bool>

name string

aliases string[]

Returns

bool

Type Parameters

T

TryGetBoolParameter(out bool, IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type bool (=> can be converted to bool).

public static bool TryGetBoolParameter(out bool value, IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

value bool

Set to the value of the parameter if successful.

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type bool, false otherwise.

TryGetColorParameter(out Color, IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type Color (=> can be converted to Color).

public static bool TryGetColorParameter(out Color value, IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

value Color

Set to the value of the parameter if successful.

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type Color, false otherwise.

TryGetDefinedParameter(out string, IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases.
A parameter is well-defined if there is exactly one of the given aliases (including the name) present in the parameters.

public static bool TryGetDefinedParameter(out string value, IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

value string

Set to the name of the defined parameter if successful.

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if the parameter is well-defined, false otherwise.

TryGetFloatParameter(out float, IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type float (=> can be converted to float).

public static bool TryGetFloatParameter(out float value, IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

value float

Set to the value of the parameter if successful.

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type float, false otherwise.

TryGetIntParameter(out int, IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type int (=> can be converted to int).

public static bool TryGetIntParameter(out int value, IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

value int

Set to the value of the parameter if successful.

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type int, false otherwise.

TryGetTypedVector2Parameter(out TypedVector2, IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type TypedVector2 (=> can be converted to TypedVector2).

public static bool TryGetTypedVector2Parameter(out ParameterUtility.TypedVector2 vector, IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

vector ParameterUtility.TypedVector2

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type TypedVector2, false otherwise.

TryGetTypedVector3Parameter(out TypedVector3, IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type TypedVector3 (=> can be converted to TypedVector3).

public static bool TryGetTypedVector3Parameter(out ParameterUtility.TypedVector3 vector, IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

vector ParameterUtility.TypedVector3

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type TypedVector3, false otherwise.

TryGetVector2OffsetParameter(out Vector2, IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type Vector2Offset (=> can be converted to Vector2Offset).

public static bool TryGetVector2OffsetParameter(out Vector2 value, IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

value Vector2

Set to the value of the parameter if successful.

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type Vector2Offset, false otherwise.

TryGetVector2Parameter(out Vector2, IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type Vector2 (=> can be converted to Vector2).

public static bool TryGetVector2Parameter(out Vector2 value, IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

value Vector2

Set to the value of the parameter if successful.

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type Vector2, false otherwise.

TryGetVector3OffsetParameter(out Vector3, IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type Vector3Offset (=> can be converted to Vector3Offset).

public static bool TryGetVector3OffsetParameter(out Vector3 value, IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

value Vector3

Set to the value of the parameter if successful.

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type Vector3Offset, false otherwise.

TryGetVector3Parameter(out Vector3, IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type Vector3 (=> can be converted to Vector3).

public static bool TryGetVector3Parameter(out Vector3 value, IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

value Vector3

Set to the value of the parameter if successful.

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type Vector3, false otherwise.

TryGetWaveOffsetParameter(out WaveOffsetType, IDictionary<string, string>, string, params string[])

Check if there is a well-defined parameter of the given name or aliases that is of type WaveOffsetType (=> can be converted to WaveOffsetType).

public static bool TryGetWaveOffsetParameter(out AnimationUtility.WaveOffsetType value, IDictionary<string, string> parameters, string name, params string[] aliases)

Parameters

value AnimationUtility.WaveOffsetType

Set to the value of the parameter if successful.

parameters IDictionary<string, string>

The parameters to check.

name string

The name to check.

aliases string[]

The aliases (alternative names) to check.

Returns

bool

true if there is a well-defined parameter that is of type WaveOffsetType, false otherwise.

ValidateWaveParameters(IDictionary<string, string>, string, bool, bool, bool, bool, bool, bool, bool, bool, bool, bool)

public static bool ValidateWaveParameters(IDictionary<string, string> parameters, string prefix = "", bool upwardCurve = true, bool downwardCurve = true, bool upPeriod = true, bool downPeriod = true, bool crestWait = true, bool troughWait = true, bool waveVelocity = true, bool waveLength = true, bool waveUniformity = true, bool amplitude = true)

Parameters

parameters IDictionary<string, string>

prefix string

upwardCurve bool

downwardCurve bool

upPeriod bool

downPeriod bool

crestWait bool

troughWait bool

waveVelocity bool

waveLength bool

waveUniformity bool

amplitude bool

Returns

bool