Class ProvidedParameter

Namespace

nadena.dev.ndmf

This class declares a parameter that is supplied by a NDMF component. This is intended to be used for introspection via the ParameterInfo API. Note that exposing a ProvidedParameter does not actually add the parameter to the Expressions Parameters asset; this is left up to individual NDMF plugins. However, it can be used to detect parameter names and in-use bit counts for use in user-facing UI.

public sealed class ProvidedParameter : ICloneable

Inheritance

object

ProvidedParameter

Implements

ICloneable

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ProvidedParameter(string, ParameterNamespace, Component, PluginBase, AnimatorControllerParameterType?)

public ProvidedParameter(string name, ParameterNamespace namespace_, Component source, PluginBase plugin, AnimatorControllerParameterType? parameterType)

Parameters

name string

namespace_ ParameterNamespace

source Component

plugin PluginBase

parameterType AnimatorControllerParameterType?

Properties

BitUsage

public int BitUsage { get; }

Property Value

int

DefaultValue

The default value of this parameter, if known.

public float? DefaultValue { get; set; }

Property Value

float?

EffectiveName

The name of this parameter after remapping is applied. Defaults to the same as OriginalName.

public string EffectiveName { get; set; }

Property Value

string

ExpandTypeOnConflict

If true, conflicting parameter types will be expanded to Bool --> Int --> Float.

public bool ExpandTypeOnConflict { get; set; }

Property Value

bool

IsAnimatorOnly

public bool IsAnimatorOnly { get; set; }

Property Value

bool

IsHidden

If true, this parameter is an internal parameter that should be hidden in user-facing UI. Normally, these parameters should also use generated names to avoid collisions.

Conflict resolution: "false" wins.

public bool IsHidden { get; set; }

Property Value

bool

Namespace

public ParameterNamespace Namespace { get; }

Property Value

ParameterNamespace

OriginalName

The name of this parameter, as originally set by the component.

public string OriginalName { get; }

Property Value

string

ParameterType

The parameter type of this parameter. Ignored for PhysBones prefixes. May be null if the type is undefined (e.g. with contact receivers).

public AnimatorControllerParameterType? ParameterType { get; set; }

Property Value

AnimatorControllerParameterType?

Plugin

The NDMF plugin which sourced this parameter.

public PluginBase Plugin { get; }

Property Value

PluginBase

Source

The component which originated this parameter.

public Component Source { get; }

Property Value

Component

WantSynced

If true, this parameter requests that it be synced across the network. If false, it requests not to be synced.

Ignored for animator-only values.

public bool WantSynced { get; set; }

Property Value

bool

Methods

Clone()

public ProvidedParameter Clone()

Returns

ProvidedParameter

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

SubParameters()

public IEnumerable<ProvidedParameter> SubParameters()

Returns

IEnumerable<ProvidedParameter>