Add this class to a character so it can use weapons Note that this component will trigger animations (if their parameter is present in the Animator), based on the current weapon's Animations Animator parameters : defined from the Weapon's inspector.
More...
|
| override string | HelpBoxText () |
| | This method is only used to display a helpbox text at the beginning of the ability's inspector.
|
| virtual void | Setup () |
| | Grabs various components and inits stuff.
|
| override void | ProcessAbility () |
| | Every frame we check if it's needed to update the ammo display.
|
| virtual void | ShootStart () |
| | Causes the character to start shooting.
|
| virtual void | ShootStop () |
| | Causes the character to stop shooting.
|
| virtual void | ForceStop () |
| | A method used (usually by AIs) to force the weapon to stop.
|
| virtual void | Reload () |
| | Reloads the weapon.
|
| virtual void | ChangeWeapon (Weapon newWeapon, string weaponID, bool combo=false) |
| | Changes the character's current weapon to the one passed as a parameter.
|
| override void | Flip () |
| | Flips the current weapon if needed.
|
| virtual void | UpdateAmmoDisplay () |
| | Updates the ammo display bar and text.
|
| override void | ResetAbility () |
| | On reset ability, we cancel all the changes made.
|
| virtual void | SetInputManager (InputManager inputManager) |
| | Sets a new input manager for this ability to get input from.
|
| virtual void | BindAnimator () |
| | Binds the animator from the character and initializes the animator parameters.
|
| virtual void | ResetInput () |
| | Resets all input for this ability. Can be overridden for ability specific directives.
|
| virtual void | EarlyProcessAbility () |
| | The first of the 3 passes you can have in your ability. Think of it as EarlyUpdate() if it existed.
|
| virtual void | LateProcessAbility () |
| | The last of the 3 passes you can have in your ability. Think of it as LateUpdate()
|
| virtual void | UpdateAnimator () |
| | Override this to send parameters to the character's animator. This is called once per cycle, by the Character class, after Early, normal and Late process().
|
| virtual void | PermitAbility (bool abilityPermitted) |
| | Changes the status of the ability's permission.
|
| virtual void | PlayAbilityStartFeedbacks () |
| | Plays the ability start feedback.
|
| virtual void | StopStartFeedbacks () |
| | Stops the ability used feedback.
|
| virtual void | PlayAbilityStopFeedbacks () |
| | Plays the ability stop feedback.
|
| virtual void | RegisterAnimatorParameter (string parameterName, AnimatorControllerParameterType parameterType, out int parameter) |
| | Registers a new animator parameter to the list.
|
|
| Weapon | InitialWeapon |
| | the initial weapon owned by the character
|
| bool | CanPickupWeapons = true |
| | if this is set to true, the character can pick up PickableWeapons
|
| Transform | WeaponAttachment |
| | the position the weapon will be attached to. If left blank, will be this.transform.
|
| bool | ForceWeaponScaleResetOnEquip = false |
| | if this is true, the weapon's scale will be forced to 1,1,1 when equipped
|
| bool | ForceWeaponRotationResetOnEquip = false |
| | if this is true, the weapon's rotation will be forced to Identity when equipped
|
| bool | AutomaticallyBindAnimator = true |
| | if this is true this animator will be automatically bound to the weapon
|
| int | AmmoDisplayID = 0 |
| | the ID of the AmmoDisplay this ability should update
|
| bool | ContinuousPress = false |
| | if this is true you won't have to release your fire button to auto reload
|
| bool | GettingHitInterruptsAttack = false |
| | whether or not this character getting hit should interrupt its attack (will only work if the weapon is marked as interruptable)
|
| bool | CanShootFromLadders = false |
| | whether or not this character is allowed to shoot while on a ladder)
|
| bool | FaceWeaponDirection = false |
| | if this is set to true, the character will be forced to face the current weapon direction
|
| bool | InvertHorizontalAimWhenWallclinging = false |
| | if this is true, horizontal aim will be inverted when shooting while wallclinging, to shoot away from the wall
|
| bool | ForceAlwaysShoot = false |
| | if this is true, the character will continuously fire its weapon
|
| bool | BufferInput |
| | whether or not attack input should be buffered, letting you prepare an attack while another is being performed, making it easier to chain them
|
| bool | NewInputExtendsBuffer |
| | if this is true, every new input will prolong the buffer
|
| float | MaximumBufferDuration = 0.25f |
| | the maximum duration for the buffer, in seconds
|
| Weapon | CurrentWeapon |
| | returns the current equipped weapon
|
| MMFeedbacks | AbilityStartFeedbacks |
| | the feedbacks to play when the ability starts
|
| MMFeedbacks | AbilityStopFeedbacks |
| | the feedbacks to play when the ability stops
|
| bool | AbilityPermitted = true |
| | if true, this ability can perform as usual, if not, it'll be ignored. You can use this to unlock abilities over time for example
|
| CharacterStates.MovementStates[] | BlockingMovementStates |
| | an array containing all the blocking movement states. If the Character is in one of these states and tries to trigger this ability, it won't be permitted. Useful to prevent this ability from being used while Idle or Swimming, for example.
|
| CharacterStates.CharacterConditions[] | BlockingConditionStates |
| | an array containing all the blocking condition states. If the Character is in one of these states and tries to trigger this ability, it won't be permitted. Useful to prevent this ability from being used while dead, for example.
|
| Weapon.WeaponStates[] | BlockingWeaponStates |
| | an array containing all the blocking weapon states. If one of the character's weapons is in one of these states and yet the character tries to trigger this ability, it won't be permitted. Useful to prevent this ability from being used while attacking, for example.
|
|
| override void | Initialization () |
| | Gets and stores components for further use.
|
| virtual void | HandleWeaponStop () |
| | Checks for state changes to trigger stop feedbacks.
|
| virtual void | HandleFacingDirection () |
| | If FaceWeaponDirection is true, will force the character to face the weapon direction.
|
| override void | HandleInput () |
| | Gets input and triggers methods based on what's been pressed.
|
| virtual void | HandleBuffer () |
| | Triggers an attack if the weapon is idle and an input has been buffered.
|
| override void | OnRespawn () |
| | On respawn we setup our weapon again.
|
| override void | OnHit () |
| | On hit we interrupt our weapon if needed.
|
| override void | OnDeath () |
| | On death we stop shooting if needed.
|
| virtual void | Start () |
| | On Start(), we call the ability's intialization.
|
| virtual void | InitializeAnimatorParameters () |
| | Adds required animator parameters to the animator parameters list if they exist.
|
| virtual void | InternalHandleInput () |
| | Internal method to check if an input manager is present or not.
|
| virtual void | OnEnable () |
| | On enable, we bind our respawn delegate.
|
| virtual void | OnDisable () |
| | On disable, we unbind our respawn delegate.
|
Add this class to a character so it can use weapons Note that this component will trigger animations (if their parameter is present in the Animator), based on the current weapon's Animations Animator parameters : defined from the Weapon's inspector.
1.14.0