WindModifier Class

Summary

An FlexiMotion.Modifiers.AccelerationModifier which randomizes its FlexiMotion.Modifiers.AccelerationModifier.Acceleration every frame and can apply temporary gusts.
Assembly
FlexiMotion.dll
Namespace
FlexiMotion.Modifiers
Interfaces
Base Types
graph BT Type-->Base0["AccelerationModifier"] click Base0 "/flexi-motion/api/FlexiMotion.Modifiers/AccelerationModifier" Base0-->Base1["FlexiMotionModifier"] click Base1 "/flexi-motion/api/FlexiMotion.Modifiers/FlexiMotionModifier" Base1-->Base2["MonoBehaviour"] Type-.->Interface0["IFlexiMotionModifier"] click Interface0 "/flexi-motion/api/FlexiMotion.Modifiers/IFlexiMotionModifier" Type-.->Interface1["IOnValidate"] click Interface1 "/flexi-motion/api/FlexiMotion/IOnValidate" Type-.->Interface2["JobModifierGroup.IOnInitialize"] click Interface2 "/flexi-motion/api/FlexiMotion.Modifiers/IOnInitialize" Type-.->Interface3["JobModifierGroup.IOnUpdate"] click Interface3 "/flexi-motion/api/FlexiMotion.Modifiers/IOnUpdate" Type["WindModifier"] class Type type-node

Syntax

[AddComponentMenu(FMStrings.ModifiersMenuPrefix + "Wind Modifier")]
[HelpURL(FMStrings.DocsURLs.ModifiersAPIDocumentation + "/" + nameof(WindModifier))]
public class WindModifier : AccelerationModifier, IFlexiMotionModifier, IOnValidate, 
    JobModifierGroup.IOnInitialize, JobModifierGroup.IOnUpdate

Attributes

Type Description
AddComponentMenu
HelpURLAttribute

Fields

Name Constant Value Summary
ExecutionTime 100
Execute fairly early.
Inherited from AccelerationModifier
static
Magnitude 0.01
A multiplier for the amount of velocity applied.
Inherited from AccelerationModifier
static
TargetFieldName _Target
The name of the serialized backing field of FlexiMotion.Modifiers.FlexiMotionModifier.Target.
Inherited from FlexiMotionModifier
static

Properties

Name Value Summary
Acceleration Vector3
[UnityEngine.SerializeField] The amount of acceleration to apply every frame.
Inherited from AccelerationModifier
DeltaTime float
The FlexiMotion.FlexiMotionRuntime.DeltaTime.
Inherited from FlexiMotionModifier
GustAcceleration Vector3
Additional acceleration to apply while a gust is active.
GustDuration float
How long a gust lasts (in seconds).
Job Float3OffsetJob
The job used to execute the acceleration.
Inherited from AccelerationModifier
Randomization float
A random value of this magnitude will be added to the acceleration each frame.
Target FlexiMotionComponent
Inherited from FlexiMotionModifier

Methods

Name Value Summary
Disable(JobModifierGroup) bool
Registers this modifier in the given FlexiMotion.Modifiers.JobModifierGroup.
Inherited from AccelerationModifier
Enable(JobModifierGroup) void
Registers this modifier in the given FlexiMotion.Modifiers.JobModifierGroup.
Inherited from AccelerationModifier
GetUsedBones() IEnumerable<Transform>
Returns the objects that are used by this modifier.
Inherited from FlexiMotionModifier
OnDisable() void
Calls FlexiMotion.Modifiers.FlexiMotionModifier.Disable(FlexiMotion.Modifiers.JobModifierGroup) if the FlexiMotion.Modifiers.FlexiMotionModifier.Target is set.
Inherited from FlexiMotionModifier
OnEnable() void
Calls FlexiMotion.Modifiers.FlexiMotionModifier.Enable(FlexiMotion.Modifiers.JobModifierGroup) if the FlexiMotion.Modifiers.FlexiMotionModifier.Target is set.
Inherited from FlexiMotionModifier
OnInitialize(JobHandle) JobHandle
A job modifier which runs when the simulation is initialized.
Inherited from AccelerationModifier
OnUpdate(JobHandle) JobHandle
A job modifier which runs after each iteration of an update.
OnValidate() void
Tries to find a FlexiMotion.Modifiers.FlexiMotionModifier.Target if none was assigned.
Inherited from FlexiMotionModifier
SchedulePosition(float3, JobHandle) JobHandle
Schedules the FlexiMotion.Modifiers.AccelerationModifier.Job to move its positions.
Inherited from AccelerationModifier
ScheduleVelocity(float3, JobHandle) JobHandle
Schedules the FlexiMotion.Modifiers.AccelerationModifier.Job to add to its velocities.
Inherited from AccelerationModifier
StartGust() void
Starts a gust.

Extension Methods

Name Value Summary
LogTemp<WindModifier>(Object) T
Debug.Log(message, context) with an [System.ObsoleteAttribute] warning so you remember to remove any calls.
SafeGetHashCode<WindModifier>() int
Uses System.Collections.Generic.EqualityComparer`1.Default to get a hash code.