Enum ParameterKind 

#[repr(u32)]
pub enum ParameterKind {
    GameControlled = 0,
    AutomaticDistance = 1,
    AutomaticEventConeAngle = 2,
    AutomaticEventOrientation = 3,
    AutomaticDirection = 4,
    AutomaticElevation = 5,
    AutomaticListenerOrientation = 6,
    AutomaticSpeed = 7,
    AutomaticSpeedAbsolute = 8,
    AutomaticDistanceNormalized = 9,
}

Available on crate feature studio only.

Event parameter types.

Variants

GameControlled = 0

API settable parameter.

AutomaticDistance = 1

Distance between the event and the listener.

AutomaticEventConeAngle = 2

Angle between the event’s forward vector and the vector pointing from the event to the listener (0 to 180 degrees).

AutomaticEventOrientation = 3

Horizontal angle between the event’s forward vector and listener’s forward vector (-180 to 180 degrees).

AutomaticDirection = 4

Horizontal angle between the listener’s forward vector and the vector pointing from the listener to the event (-180 to 180 degrees).

AutomaticElevation = 5

Angle between the listener’s XZ plane and the vector pointing from the listener to the event (-90 to 90 degrees).

AutomaticListenerOrientation = 6

Horizontal angle between the listener’s forward vector and the global positive Z axis (-180 to 180 degrees).

AutomaticSpeed = 7

Magnitude of the relative velocity of the event and the listener.

AutomaticSpeedAbsolute = 8

Magnitude of the absolute velocity of the event.

AutomaticDistanceNormalized = 9

Distance between the event and the listener in the range min distance - max distance represented as 0 - 1.

Trait Implementations

impl Clone for ParameterKind

fn clone(&self) -> ParameterKind

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ParameterKind

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<ParameterKind> for u32

fn from(enum_value: ParameterKind) -> Self

Converts to this type from the input type.

impl PartialEq for ParameterKind

fn eq(&self, other: &ParameterKind) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<u32> for ParameterKind

type Error = TryFromPrimitiveError<ParameterKind>

The type returned in the event of a conversion error.

fn try_from(number: u32) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFromPrimitive for ParameterKind

const NAME: &'static str = "ParameterKind"

type Primitive = u32

type Error = TryFromPrimitiveError<ParameterKind>

fn try_from_primitive( number: Self::Primitive, ) -> Result<Self, TryFromPrimitiveError<Self>>

impl UnsafeFromPrimitive for ParameterKind

type Primitive = u32

unsafe fn unchecked_transmute_from(number: Self::Primitive) -> Self

Transmutes into an enum from its primitive.

unsafe fn from_unchecked(number: Self::Primitive) -> Self

👎Deprecated since 0.6.0: Prefer to use unchecked_transmute_from, from_unchecked will be removed in a future release.

Transmutes into an enum from its primitive.

impl Copy for ParameterKind

impl Eq for ParameterKind

impl StructuralPartialEq for ParameterKind