Overview Page:
| Class Name | AtavismWeaponIKStateToggle |
|---|---|
| Namespace | HNGamers.Atavism |
| Inheritance | StateMachineBehaviour |
| Description | This class is used to toggle the Atavism Weapon IK state. It contains enums for different states and types of toggling. It also has methods to update the IK handlers in different states. |
| Remarks | None |
Interface Pages:
There are no interfaces in this class.
Constructor Pages:
There are no constructors in this class.
Method Pages:
| Method | Description |
|---|---|
| UpdateIKHandlers | This method updates the IK handlers for different targets based on the specified toggle type. |
| OnStateEnter | This method is called on the first frame the state is active. If the mobIdleState is true, it sets the AtavismMobIKSystem mobIdleState to true, else it sets it to false. If toggleState is OnStateEnter, it calls the UpdateIKHandlers method. |
| OnStateUpdate | This method is called on each frame the state is active. If the mobIdleState is true, it sets the AtavismMobIKSystem mobIdleState to true, else it sets it to false. If toggleState is OnStateUpdate, it calls the UpdateIKHandlers method. |
| OnStateExit | This method is called on the last frame the state is active. If the mobIdleState is true, it sets the AtavismMobIKSystem mobIdleState to true, else it sets it to false. If toggleState is OnStateExit, it calls the UpdateIKHandlers method. |
| OnStateMove | This method is called on each frame where a transform is modified by the animation. If the mobIdleState is true, it sets the AtavismMobIKSystem mobIdleState to true, else it sets it to false. If toggleState is OnStateMove, it calls the UpdateIKHandlers method. |
| OnStateIK | This method is called on each frame where the Animator needs to set up IK (Inverse Kinematics) for the character. If the mobIdleState is true, it sets the AtavismMobIKSystem mobIdleState to true, else it sets it to false. If toggleState is OnStateIK, it calls the UpdateIKHandlers method. |
Property Pages:
| Property | Type | Description |
|---|---|---|
| mobIdleState | bool | If true, sets the AtavismMobIKSystem mobIdleState to true, else it sets it to false. |
| toggleState | enum | Represents the state of the toggle. Can be one of OnStateEnter, OnStateUpdate, OnStateExit, OnStateMove, or OnStateIK. |
| toggleType | enum | Represents the type of toggle. Can be one of Enable, Disable, Toggle, MountedEnable, MountedDisable, or MountedToggle. |
Event Pages:
There are no events in this class.
Concept/Guide Pages:
There are no concept or guide pages for this class.
Examples:
There are no examples provided for this class.
