UnityAnimatorEvent

KO | EN

gitlite — search

#self-hosted #react #javascript #cross-platform #electron #privacy #awesome #deep-learning #anthropic #monitoring

UnityAnimatorEvent

(★ 11)

Animator extension that allow to add event on state enter/exit through script

File Explorer

ZIP Download

- - AnimationEvent.cs
  - AnimationEvent.cs.meta
  - AnimatorPolling.cs
  - AnimatorPolling.cs.meta
  - CallbackSMB.cs
  - CallbackSMB.cs.meta
- - Idle.fbx
  - Idle.fbx.meta
  - PutGlassesOn.fbx
  - PutGlassesOn.fbx.meta
  - TakeObjects.fbx
  - TakeObjects.fbx.meta
  - Test.controller
  - Test.controller.meta
  - Test.unity
  - Test.unity.meta
- AnimatorEvent.meta
- TestAddEvent.cs
- TestAddEvent.cs.meta
- TestData.meta
- manifest.json
- AudioManager.asset
- ClusterInputManager.asset
- DynamicsManager.asset
- EditorBuildSettings.asset
- EditorSettings.asset
- GraphicsSettings.asset
- InputManager.asset
- NavMeshAreas.asset
- NetworkManager.asset
- Physics2DSettings.asset
- PresetManager.asset
- ProjectSettings.asset
- ProjectVersion.txt
- QualitySettings.asset
- TagManager.asset
- TimeManager.asset
- UnityConnectSettings.asset
.gitignore
LICENSE
README.md

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Animator extension that allow to add event on state enter/exit and transition start/end through scripts

You can copy the content of the AnimatorEvent folder inside your project to use it.

This repo contains 2 prototype of how to do this (see Methods further down)

## Usage

To add an event, just call on your animator

```csharp
animator.AddEvent("stateName", AnimationEventType.STATE_ENTER, callback, layer);
```

**layer** is optional, if you ommit it, layer 0 (Base Layer) is used.

Examples :

```csharp
animator.AddEvent("Walk", AnimationEventType.STATE_ENTER, WalkEntered, animator.GetLayerIndex("LowerBody"));
animator.AddEvent("Idle", AnimationEventType.STATE_EXIT_TRANSITION_START, anim => { Debug.Log("State idle exit transition started at" + Time.time); });
```

### Switching methods

To switch the method the system use, change the boolean `isUsingSMBMethod` in `AnimatorAnimationEventExtension` to :
- **false** to use **Method 1**
- **true** to use **Method 2**

note that switching to method 2 will require to resave your animator for now (just move a state and save the project).

## Method 1 : Through monitoring the animator state

This method monitor if the state and transition infos changed change since last frame and and call the appropriates callbacks
This has the advantage of not modifying your assets, and just add a simple script on the monitored object at runtime.

### Drawback

This is less precise, the callback won't be called exactly when the state change as we are working in FixedUpdate function and not
being notified by Unity internal Animator messaging system.

It probably is slightly more computanional heavy, as we have to poll the animator lookup into dictionaries for callback for each states etc. 
 
Also depending on when the check occur it could occur before the StateMachine change state in the frame, leading to a frame lag before the callback call (_probably
can be alleviated by using DefaultExectionOrder attribute_)

## Method 2 : Through automatically added StateMachineBehaviour

This method automatically add a special StateMachineBehaviour called `CallbackSMB` to all the state
of your AnimatorController when it is saved on disk.

**/!\\ THIS MEAN IT MODIFY YOUR ASSETS FOR YOU /!\\**

This is the most robust as it rely on the Unity internal implementation to get when state are entered/existed

### Drawback

The drawback is that it will modify your asset, adding a StateMachineBehaviour on all state, as there is no
way to add behaviour at runtime.

That also mean that state machine created before adding the plugin need to be resaved.
(_TODO : auto resave all existing StateMachineBehaviour on plugin first import? with confirmation popup_)

UnityAnimatorEvent

Owner Repos

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

UnityAnimatorEvent

Owner Repos

File Explorer

# Use via CDN

Was this content helpful?

Recent Feedback

Download README