PlatformerPro.SpecialMovement_WeildWeapon Class Reference

A special movement which plays the weild animation, and then sets an animator override. Because it sends events this movement cannot be selected from drop down and must be added directly. More...

Inheritance diagram for PlatformerPro.SpecialMovement_WeildWeapon:

Public Member Functions
override Movement	Init (Character character, MovementVariable[] movementData)
	Initialise the mvoement with the given movement data. More...
override bool	WantsSpecialMove ()
	Gets a value indicating whether this movement wants to do a special move. More...
override void	DoSpecialMove ()
	Start the special mvoe More...
override bool	ForceMaintainControl ()
	If this is true then the movement wants to maintain control of the character even if default transition conditions suggest it shouldn't. More...
Public Member Functions inherited from PlatformerPro.BaseMovement< SpecialMovement >
sealed override Movement	Init (Character character)
	Initialise this movement. More...
bool	IsMovementDataDifferent (MovementVariable[] originalMovementData)
	Determines whether this instances movement data is different from the supplied originalMovementData. More...

Public Attributes
string	overrideName
	Name of the animation override to set. More...
int	actionButton
	Which action button triggers weilding. More...
Movement[]	weaponMovements
	List of movements to enable when weapon is weilded. More...
Movement[]	nonWeaponMovements
	List of movements to disable when weapon is weilded. More...

Protected Member Functions
virtual void	OnWeildedWeapon ()
	Raises the weilded weapon event. More...

Protected Attributes
bool	weildActive
	Are we weilding this weapon? More...
bool	weildStarted
	Have we started a weild More...
CharacterEventArgs	args
	Cached event arguments. More...
Animator	myAnimator
	Cached reference to the animator. More...
Protected Attributes inherited from PlatformerPro.BaseMovement< SpecialMovement >
Movement	implementation
	The class that will do the movement. More...
string	movementType
	The type of movement as a string. More...
MovementVariable[]	movementData
	Data that should be applied to the movement type on init. More...

Properties
new static MovementInfo	Info [get]
	Human readable name. More...
override AnimationState	AnimationState [get]
	Gets the animation state that this movement wants to set. More...
Properties inherited from PlatformerPro.SpecialMovement
new static MovementInfo	Info [get]
	Static movement info used by the editor. More...
Properties inherited from PlatformerPro.BaseMovement< SpecialMovement >
virtual string	MovementType [get, set]
	The type of movement as a string. More...
virtual MovementVariable[]	MovementData [get, set]
	Data that should be applied to the movement type on init. More...
new static MovementInfo	Info [get]
	Static movement info used by the editor. More...
override bool	Enabled [get, set]
	A custom enable which base movements can use to pass on enable values. More...
override Movement	Implementation [get]
	Gets the underlying implementation. More...

Events
System.EventHandler< CharacterEventArgs >	WeildedWeapon
	Event for weilding a weapon, use this to do things like enable weapon attacks. More...

Detailed Description

A special movement which plays the weild animation, and then sets an animator override. Because it sends events this movement cannot be selected from drop down and must be added directly.

Member Function Documentation

DoSpecialMove()

override void PlatformerPro.SpecialMovement_WeildWeapon.DoSpecialMove ( )

virtual

Start the special mvoe

Reimplemented from PlatformerPro.SpecialMovement.

ForceMaintainControl()

override bool PlatformerPro.SpecialMovement_WeildWeapon.ForceMaintainControl

(

)

If this is true then the movement wants to maintain control of the character even if default transition conditions suggest it shouldn't.

Init()

override Movement PlatformerPro.SpecialMovement_WeildWeapon.Init	(	Character	character,
		MovementVariable[]	movementData
	)

Initialise the mvoement with the given movement data.

Parameters

character	Character.
movementData	Movement data.

OnWeildedWeapon()

virtual void PlatformerPro.SpecialMovement_WeildWeapon.OnWeildedWeapon ( )

protectedvirtual

Raises the weilded weapon event.

WantsSpecialMove()

override bool PlatformerPro.SpecialMovement_WeildWeapon.WantsSpecialMove ( )

virtual

Gets a value indicating whether this movement wants to do a special move.

Reimplemented from PlatformerPro.SpecialMovement.

Member Data Documentation

actionButton

int PlatformerPro.SpecialMovement_WeildWeapon.actionButton

Which action button triggers weilding.

args

CharacterEventArgs PlatformerPro.SpecialMovement_WeildWeapon.args

protected

Cached event arguments.

myAnimator

Animator PlatformerPro.SpecialMovement_WeildWeapon.myAnimator

protected

Cached reference to the animator.

nonWeaponMovements

Movement [] PlatformerPro.SpecialMovement_WeildWeapon.nonWeaponMovements

List of movements to disable when weapon is weilded.

overrideName

string PlatformerPro.SpecialMovement_WeildWeapon.overrideName

Name of the animation override to set.

weaponMovements

Movement [] PlatformerPro.SpecialMovement_WeildWeapon.weaponMovements

List of movements to enable when weapon is weilded.

weildActive

bool PlatformerPro.SpecialMovement_WeildWeapon.weildActive

protected

Are we weilding this weapon?

weildStarted

bool PlatformerPro.SpecialMovement_WeildWeapon.weildStarted

protected

Have we started a weild

Property Documentation

AnimationState

override AnimationState PlatformerPro.SpecialMovement_WeildWeapon.AnimationState

get

Gets the animation state that this movement wants to set.

Info

new static MovementInfo PlatformerPro.SpecialMovement_WeildWeapon.Info

staticget

Human readable name.

Human readable description.

Static movement info used by the editor.

Event Documentation

WeildedWeapon

System.EventHandler<CharacterEventArgs> PlatformerPro.SpecialMovement_WeildWeapon.WeildedWeapon

Event for weilding a weapon, use this to do things like enable weapon attacks.

---

The documentation for this class was generated from the following file:

• D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/Movement/Special/SpecialMovement_WeildWeapon.cs