MoreMountains.CorgiEngine.ProjectileWeapon Class Reference

A weapon class aimed specifically at allowing the creation of various projectile weapons, from shotgun to machine gun, via plasma gun or rocket launcher. More...

Inheritance diagram for MoreMountains.CorgiEngine.ProjectileWeapon:

Public Member Functions
override void	Initialization ()
	Initialize this weapon.
virtual GameObject	SpawnProjectile (Vector3 spawnPosition, int projectileIndex, int totalProjectiles, bool triggerObjectActivation=true)
	Spawns a new object and positions/resizes it.
virtual void	DetermineSpawnPosition ()
	Determines the spawn position based on the spawn offset and whether or not the weapon is flipped.
Public Member Functions inherited from MoreMountains.CorgiEngine.Weapon
virtual void	InitializeComboWeapons ()
	Initializes the combo comp if found.
virtual void	SetOwner (Character newOwner, CharacterHandleWeapon handleWeapon)
	Sets the weapon's owner.
virtual void	WeaponInputStart ()
	Called by input, turns the weapon on.
virtual void	WeaponInputReleased ()
	Describes what happens when the weapon's input gets released.
virtual void	WeaponInputStop ()
	Called by input, turns the weapon off if in auto mode.
virtual void	TurnWeaponOn ()
	Describes what happens when the weapon starts.
virtual void	TurnWeaponOff ()
	Turns the weapon off.
virtual void	Interrupt ()
	Call this method to interrupt the weapon.
virtual bool	WeaponInCooldown ()
virtual void	SetCooldownStartAt ()
virtual void	ResetCooldown ()
	Lets you reset the cooldown of the weapon.
virtual IEnumerator	ShootRequestCo ()
	Determines whether or not the weapon can fire.
virtual void	InitiateReloadWeapon ()
virtual void	FlipWeapon ()
	Flips the weapon.
virtual void	FlipWeaponModel ()
	Flips the weapon model.
virtual IEnumerator	WeaponDestruction ()
	Destroys the weapon.
virtual void	ApplyRecoil (bool shouldApplyRecoil, WeaponRecoilProperties properties)
virtual void	InitializeAnimatorParameters ()
	Adds required animator parameters to the animator parameters list if they exist.
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	ResetComboAnimatorParameter ()
virtual void	ResetAnimatorParameters ()
virtual void	WeaponHit ()
virtual void	WeaponHitDamageable ()
virtual void	WeaponHitNonDamageable ()
virtual void	WeaponMiss ()
virtual void	WeaponKill ()

Public Attributes
Transform	ProjectileSpawnTransform
	the transform to use as the center reference point of the spawn
Vector3	ProjectileSpawnOffset = Vector3.zero
	the offset position at which the projectile will spawn
int	ProjectilesPerShot = 1
	the number of projectiles to spawn per shot
Vector3	Spread = Vector3.zero
	the spread (in degrees) to apply randomly (or not) on each angle when spawning a projectile
bool	RotateWeaponOnSpread = false
	whether or not the weapon should rotate to align with the spread angle
bool	RandomSpread = true
	whether or not the spread should be random (if not it'll be equally distributed)
MMObjectPooler	ObjectPooler
	the object pooler used to spawn projectiles, if left empty, this component will try to find one on its game object
Vector3	SpawnPosition = Vector3.zero
	the local position at which this projectile weapon should spawn projectiles
Public Attributes inherited from MoreMountains.CorgiEngine.Weapon
TriggerModes	TriggerMode = TriggerModes.Auto
	is this weapon on semi or full auto ?
bool	Interruptable = false
	whether or not this weapon can be interrupted
bool	InitializeOnStart = false
	If this is true, the weapon will initialize itself on start, otherwise it'll have to be init manually, usually by the CharacterHandleWeapon class.
float	DelayBeforeUse = 0f
	the delay before use, that will be applied for every shot
bool	DelayBeforeUseReleaseInterruption = true
	whether or not the delay before used can be interrupted by releasing the shoot button (if true, releasing the button will cancel the delayed shot)
float	TimeBetweenUses = 1f
	the time (in seconds) between two shots
bool	TimeBetweenUsesReleaseInterruption = true
	whether or not the time between uses can be interrupted by releasing the shoot button (if true, releasing the button will cancel the time between uses)
float	CooldownDuration = 0f
	a duration, in seconds, at the end of the weapon's life cycle and before going back to Idle
bool	UseBurstMode = false
	if this is true, the weapon will activate repeatedly for every shoot request
int	BurstLength = 3
	the amount of 'shots' in a burst sequence
float	BurstTimeBetweenShots = 0.1f
	the time between shots in a burst sequence (in seconds)
bool	MagazineBased = false
	whether or not the weapon is magazine based. If it's not, it'll just take its ammo inside a global pool
int	MagazineSize = 30
	the size of the magazine
bool	AutoReload
	if this is true, pressing the fire button when a reload is needed will reload the weapon. Otherwise you'll need to press the reload button
float	ReloadTime = 2f
	the time it takes to reload the weapon
int	AmmoConsumedPerShot = 1
	the amount of ammo consumed everytime the weapon fires
bool	AutoDestroyWhenEmpty
	if this is set to true, the weapon will auto destroy when there's no ammo left
float	AutoDestroyWhenEmptyDelay = 1f
	the delay (in seconds) before weapon destruction if empty
int	CurrentAmmoLoaded = 0
	the current amount of ammo loaded inside the weapon
Vector3	WeaponAttachmentOffset = Vector3.zero
	an offset that will be applied to the weapon once attached to the center of the WeaponAttachment transform.
bool	FlipWeaponOnCharacterFlip = true
	should that weapon be flipped when the character flips ?
Vector3	FlipValue = new Vector3(-1,1,1)
	the FlipValue will be used to multiply the model's transform's localscale on flip. Usually it's -1,1,1, but feel free to change it to suit your model's specs
Transform	LeftHandHandle
	the transform to which the character's left hand should be attached to
Transform	RightHandHandle
	the transform to which the character's right hand should be attached to
bool	ModifyMovementWhileEquipped = false
	if this is true, a multiplier will be applied to movement while the weapon is equipped
float	PermanentMovementMultiplier = 0f
	the multiplier to apply to movement while equipped
bool	ModifyMovementWhileAttacking = false
	if this is true, a multiplier will be applied to movement while the weapon is active
float	MovementMultiplier = 0f
	the multiplier to apply to movement while attacking
bool	AlwaysResetMultiplierToInitial = true
	if this is true, movement will always be reset to initial speed after a multiplier stops being applied
bool	PreventHorizontalGroundMovementWhileInUse = false
	if this is true all movement will be prevented (even flip) while the weapon is active
bool	PreventHorizontalAirMovementWhileInUse = false
	if this is true all horizontal air movement will be prevented (even flip) while the weapon is active
bool	SetForceWhileInUse = false
	whether or not to apply a force when the weapon is in use
Vector2	ForceWhileInUse = Vector2.zero
	the force to apply when the weapon is in use, if SetForceWhileInUse is true
bool	DisableGravityWhileInUse = false
	whether or not to disable gravity while the weapon is in use
bool	PreventFlipWhileInUse = false
	whether or not to disable flip while the weapon is in use
List< Animator >	Animators
	the other animators (other than the Character's) that you want to update every time this weapon gets used
bool	MirrorCharacterAnimatorParameters = false
	if this is true, the weapon's animator(s) will mirror the animation parameter of the owner character (that way your weapon's animator will be able to "know" if the character is walking, jumping, etc)
string	EquippedAnimationParameter
string	IdleAnimationParameter
	the name of the weapon's idle animation parameter : this will be true all the time except when the weapon is being used
string	StartAnimationParameter
	the name of the weapon's start animation parameter : true at the frame where the weapon starts being used
string	DelayBeforeUseAnimationParameter
	the name of the weapon's delay before use animation parameter : true when the weapon has been activated but hasn't been used yet
string	SingleUseAnimationParameter
	the name of the weapon's single use animation parameter : true at each frame the weapon activates (shoots)
string	UseAnimationParameter
	the name of the weapon's in use animation parameter : true at each frame the weapon has started firing but hasn't stopped yet
string	DelayBetweenUsesAnimationParameter
	the name of the weapon's delay between each use animation parameter : true when the weapon is in use
string	InCooldownAnimationParameter
	the name of the weapon's in cooldown animation parameter : true when the weapon is in cooldown
string	StopAnimationParameter
	the name of the weapon stop animation parameter : true after a shot and before the next one or the weapon's stop
string	ReloadStartAnimationParameter
	the name of the weapon reload start animation parameter
string	ReloadAnimationParameter
	the name of the weapon reload animation parameter
string	ReloadStopAnimationParameter
	the name of the weapon reload end animation parameter
string	WeaponAngleAnimationParameter
	the name of the weapon's angle animation parameter
string	WeaponAngleRelativeAnimationParameter
	the name of the weapon's angle animation parameter, adjusted so it's always relative to the direction the character is currently facing
MMFeedbacks	WeaponStartMMFeedback
	the feedback to play when the weapon starts being used
MMFeedbacks	WeaponUsedMMFeedback
	the feedback to play while the weapon is in use
MMFeedbacks	WeaponStopMMFeedback
	the feedback to play when the weapon stops being used
MMFeedbacks	WeaponReloadMMFeedback
	the feedback to play when the weapon gets reloaded
MMFeedbacks	WeaponReloadNeededMMFeedback
	the feedback to play when the weapon gets reloaded
MMFeedbacks	WeaponOnHitFeedback
	A MMFeedback to play when the weapon hits anything (damageable or not)
MMFeedbacks	WeaponOnMissFeedback
	A MMFeedback to play when the weapon misses (what constitutes a miss is defined per Weapon subclass)
MMFeedbacks	WeaponOnHitDamageableFeedback
	A MMFeedback to play when the weapon hits a damageable.
MMFeedbacks	WeaponOnHitNonDamageableFeedback
	A MMFeedback to play when the weapon hits a non damageable object.
MMFeedbacks	WeaponOnKillFeedback
	A MMFeedback to play when the weapon kills something.
bool	ApplyRecoilOnUse = false
	Whether or not to apply recoil to the Weapon owner every time this weapon gets used, regardless of the outcome.
WeaponRecoilProperties	RecoilOnUseProperties
	The recoil to apply every time this weapon gets used.
bool	ApplyRecoilOnHitDamageable = false
	Whether or not to apply recoil to the Weapon owner every time this weapon hits a damageable object (an object with a Health component, basically)
WeaponRecoilProperties	RecoilOnHitDamageableProperties
	the recoil to apply when this weapon hits a damageable
bool	ApplyRecoilOnHitNonDamageable = false
	Whether or not to apply recoil to the Weapon owner every time this weapon hits a non damageable object (a platform, prop, etc)
WeaponRecoilProperties	RecoilOnHitNonDamageableProperties
	the recoil to apply when this weapon hits a non damageable
bool	ApplyRecoilOnMiss = false
	Whether or not to apply recoil to the Weapon owner every time the weapon misses its hit.
WeaponRecoilProperties	RecoilOnMissProperties
	the recoil to apply when this weapon hits nothing
bool	ApplyRecoilOnKill = false
	Whether or not to apply recoil to the Weapon owner every time the weapon kills its target.
WeaponRecoilProperties	RecoilOnKillProperties
	The recoil to apply on kill.
MMStateMachine< WeaponStates >	WeaponState
	the weapon's state machine

Protected Member Functions
override void	LateUpdate ()
	On LateUpdate, processes the weapon state.
override void	WeaponUse ()
	Called everytime the weapon is used.
virtual void	OnDrawGizmosSelected ()
	When the weapon is selected, draws a circle at the spawn's position.
Protected Member Functions inherited from MoreMountains.CorgiEngine.Weapon
virtual void	Start ()
virtual void	InitializeFeedbacks ()
	Initializes all the feedbacks associated to this weapon.
virtual void	Update ()
	On Update, we check if the weapon is or should be used.
virtual void	PreventMovement ()
	Handles movement prevention in air or on ground.
virtual void	RestoreMovement ()
virtual IEnumerator	ApplyForceWhileInUseCo ()
	An internal coroutine used to apply a force while the weapon's in use.
virtual void	ProcessWeaponState ()
	Called every lastUpdate, processes the weapon's state machine.
virtual void	CaseWeaponIdle ()
virtual void	CaseWeaponStart ()
virtual void	CaseWeaponDelayBeforeUse ()
virtual void	CaseWeaponUse ()
virtual void	CaseWeaponDelayBetweenUses ()
virtual void	CaseWeaponStop ()
virtual void	CaseWeaponInCooldown ()
virtual void	CaseWeaponReloadNeeded ()
virtual void	CaseWeaponReloadStart ()
virtual void	CaseWeaponReload ()
virtual void	CaseWeaponReloadStop ()
virtual void	CaseWeaponInterrupted ()
virtual void	ShootRequest ()
	Determines whether or not the weapon can fire.
virtual void	ResetMovementMultiplier ()
virtual void	ReloadNeeded ()
	Describes what happens when the weapon needs a reload.
virtual void	ReloadWeapon ()
	Reloads the weapon.
virtual void	ApplyOffset ()
	Applies the offset specified in the inspector.
virtual IEnumerator	ApplyRecoilCoroutine (WeaponRecoilProperties properties)
virtual void	ApplyRecoilInternal (WeaponRecoilProperties properties)
virtual Vector2	GetRecoilDirection (WeaponRecoilProperties properties)
virtual void	TriggerWeaponStartFeedback ()
	Plays the weapon's start sound.
virtual void	TriggerWeaponUsedFeedback ()
	Plays the weapon's used sound.
virtual void	TriggerWeaponStopFeedback ()
	Plays the weapon's stop sound.
virtual void	TriggerWeaponReloadNeededFeedback ()
	Plays the weapon's reload needed sound.
virtual void	TriggerWeaponReloadFeedback ()
	Plays the weapon's reload sound.
virtual void	TriggerWeaponOnHitFeedback ()
	Plays a feedback when the weapon hits something.
virtual void	TriggerWeaponOnMissFeedback ()
	Plays a feedback when the weapon doesn't hit something.
virtual void	TriggerWeaponOnHitDamageableFeedback ()
	Plays a feedback when the weapon hits a damageable.
virtual void	TriggerWeaponOnHitNonDamageableFeedback ()
	Plays a feedback when the weapon hits a non damageable.
virtual void	TriggerWeaponOnKillFeedback ()
	Plays a feedback when the weapon kills something.
virtual void	AddParametersToAnimator (Animator animator, HashSet< int > list)
virtual void	UpdateAnimator (Animator animator, HashSet< int > list)
virtual void	ResetAnimatorParameters (Animator animator, HashSet< int > list)
virtual void	OnDisable ()

Protected Attributes
Vector3	_flippedProjectileSpawnOffset
Vector3	_randomSpreadDirection
Vector3	_spawnPositionCenter
bool	_poolInitialized = false
Vector2	_offset
Protected Attributes inherited from MoreMountains.CorgiEngine.Weapon
SpriteRenderer	_spriteRenderer
CharacterGravity	_characterGravity
CorgiController	_controller
CharacterHorizontalMovement	_characterHorizontalMovement
WeaponAim	_aimableWeapon
float	_permanentMovementMultiplierStorage = 1f
float	_movementMultiplierStorage = 1f
Animator	_ownerAnimator
float	_delayBeforeUseCounter = 0f
float	_delayBetweenUsesCounter = 0f
float	_cooldownStartAt = float.NegativeInfinity
float	_reloadingCounter = 0f
bool	_triggerReleased = false
bool	_reloading = false
ComboWeapon	_comboWeapon
Vector3	_weaponOffset
Vector3	_weaponAttachmentOffset
Transform	_weaponAttachment
List< HashSet< int > >	_animatorParameters
HashSet< int >	_ownerAnimatorParameters
bool	_initialized = false
bool	_applyForceWhileInUse = false
Vector2	_forceWhileInUse
bool	_movementMultiplierNeedsResetting = false
int	_equippedAnimationParameter
int	_idleAnimationParameter
int	_startAnimationParameter
int	_delayBeforeUseAnimationParameter
int	_singleUseAnimationParameter
int	_useAnimationParameter
int	_delayBetweenUsesAnimationParameter
int	_inCooldownAnimationParameter
int	_stopAnimationParameter
int	_reloadStartAnimationParameter
int	_reloadAnimationParameter
int	_reloadStopAnimationParameter
int	_weaponAngleAnimationParameter
int	_weaponAngleRelativeAnimationParameter
int	_aliveAnimationParameter
int	_comboInProgressAnimationParameter
Vector2	_recoilDirection
bool	_characterHorizontalMovementNotNull = false
bool	_controllerNotNull = false
float	_lastTurnWeaponOnAt = -float.MaxValue
bool	_gravityBeforeUse = true
bool	_canFlipBeforeUse = true
Vector3	_newHandleAngles

Properties
bool	WallClinging [get, set]
Properties inherited from MoreMountains.CorgiEngine.Weapon
string	WeaponID [get, set]
	the name of the inventory item corresponding to this weapon. Automatically set (if needed) by InventoryEngineWeapon
Character	Owner [get, protected set]
	the weapon's owner
CharacterHandleWeapon	CharacterHandleWeapon [get, set]
	the weapon's owner's CharacterHandleWeapon component
bool	Flipped [get, set]
	if true, the weapon is flipped
WeaponAmmo	WeaponAmmo [get, protected set]
	the WeaponAmmo component optionnally associated to this weapon

Additional Inherited Members
Public Types inherited from MoreMountains.CorgiEngine.Weapon
enum	TriggerModes { SemiAuto , Auto }
	the possible use modes for the trigger More...
enum	WeaponStates {   WeaponIdle , WeaponStart , WeaponDelayBeforeUse , WeaponUse ,   WeaponDelayBetweenUses , WeaponStop , WeaponReloadNeeded , WeaponReloadStart ,   WeaponReload , WeaponReloadStop , WeaponInterrupted , WeaponInCooldown }
	the possible states the weapon can be in More...
Static Protected Attributes inherited from MoreMountains.CorgiEngine.Weapon
const string	_aliveAnimationParameterName = "Alive"

Detailed Description

A weapon class aimed specifically at allowing the creation of various projectile weapons, from shotgun to machine gun, via plasma gun or rocket launcher.

Member Function Documentation

DetermineSpawnPosition()

virtual void MoreMountains.CorgiEngine.ProjectileWeapon.DetermineSpawnPosition ( )

virtual

Determines the spawn position based on the spawn offset and whether or not the weapon is flipped.

Initialization()

override void MoreMountains.CorgiEngine.ProjectileWeapon.Initialization ( )

virtual

Initialize this weapon.

Reimplemented from MoreMountains.CorgiEngine.Weapon.

LateUpdate()

override void MoreMountains.CorgiEngine.ProjectileWeapon.LateUpdate ( )

protectedvirtual

On LateUpdate, processes the weapon state.

Reimplemented from MoreMountains.CorgiEngine.Weapon.

OnDrawGizmosSelected()

virtual void MoreMountains.CorgiEngine.ProjectileWeapon.OnDrawGizmosSelected ( )

protectedvirtual

When the weapon is selected, draws a circle at the spawn's position.

SpawnProjectile()

virtual GameObject MoreMountains.CorgiEngine.ProjectileWeapon.SpawnProjectile ( Vector3 spawnPosition, int projectileIndex, int totalProjectiles, bool triggerObjectActivation = true )

virtual

Spawns a new object and positions/resizes it.

we get the next object in the pool and make sure it's not null

WeaponUse()

override void MoreMountains.CorgiEngine.ProjectileWeapon.WeaponUse ( )

protectedvirtual

Called everytime the weapon is used.

Reimplemented from MoreMountains.CorgiEngine.Weapon.

Member Data Documentation

_flippedProjectileSpawnOffset

Vector3 MoreMountains.CorgiEngine.ProjectileWeapon._flippedProjectileSpawnOffset

protected

_offset

Vector2 MoreMountains.CorgiEngine.ProjectileWeapon._offset

protected

_poolInitialized

bool MoreMountains.CorgiEngine.ProjectileWeapon._poolInitialized = false

protected

_randomSpreadDirection

Vector3 MoreMountains.CorgiEngine.ProjectileWeapon._randomSpreadDirection

protected

_spawnPositionCenter

Vector3 MoreMountains.CorgiEngine.ProjectileWeapon._spawnPositionCenter

protected

ObjectPooler

MMObjectPooler MoreMountains.CorgiEngine.ProjectileWeapon.ObjectPooler

the object pooler used to spawn projectiles, if left empty, this component will try to find one on its game object

ProjectileSpawnOffset

Vector3 MoreMountains.CorgiEngine.ProjectileWeapon.ProjectileSpawnOffset = Vector3.zero

the offset position at which the projectile will spawn

ProjectileSpawnTransform

Transform MoreMountains.CorgiEngine.ProjectileWeapon.ProjectileSpawnTransform

the transform to use as the center reference point of the spawn

ProjectilesPerShot

int MoreMountains.CorgiEngine.ProjectileWeapon.ProjectilesPerShot = 1

the number of projectiles to spawn per shot

RandomSpread

bool MoreMountains.CorgiEngine.ProjectileWeapon.RandomSpread = true

whether or not the spread should be random (if not it'll be equally distributed)

RotateWeaponOnSpread

bool MoreMountains.CorgiEngine.ProjectileWeapon.RotateWeaponOnSpread = false

whether or not the weapon should rotate to align with the spread angle

SpawnPosition

Vector3 MoreMountains.CorgiEngine.ProjectileWeapon.SpawnPosition = Vector3.zero

the local position at which this projectile weapon should spawn projectiles

Spread

Vector3 MoreMountains.CorgiEngine.ProjectileWeapon.Spread = Vector3.zero

the spread (in degrees) to apply randomly (or not) on each angle when spawning a projectile

Property Documentation

WallClinging

bool MoreMountains.CorgiEngine.ProjectileWeapon.WallClinging

getset

---

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

• Assets/CorgiEngine/Common/Scripts/Agents/Weapons/ProjectileWeapon.cs