Corgi Engine  v8.8
MoreMountains.CorgiEngine.PickableWeapon Class Reference

Add this class to a collectible to have the player change weapon when collecting it More...

Inheritance diagram for MoreMountains.CorgiEngine.PickableWeapon:
MoreMountains.CorgiEngine.PickableItem MoreMountains.CorgiEngine.CorgiMonoBehaviour

Public Attributes

Weapon WeaponToGive
 the new weapon the player gets when collecting this object More...
 
int HandleWeaponID = 1
 the ID of the CharacterHandleWeapon ability you want this weapon to go to (1 by default) More...
 
- Public Attributes inherited from MoreMountains.CorgiEngine.PickableItem
MMFeedbacks PickFeedbacks
 the MMFeedback to play when the item gets picked More...
 
bool DisableObjectOnPick = true
 if this is set to true, the object will be disabled when picked More...
 
bool DisableRendererOnPick = false
 if this is true, disable the object's renderer on pick More...
 
bool DisableColliderOnPick = false
 if this is true, disable the object's collider on pick More...
 
bool DisableTargetObjectOnPick = false
 if this is set to true, the target object will be disabled when picked More...
 
GameObject TargetObjectToDisable
 the object to disable on pick if DisableTargetObjectOnPick is true More...
 
float TargetObjectDisableDelay = 1f
 the time in seconds before disabling the target if DisableTargetObjectOnPick is true More...
 

Protected Member Functions

override void Pick (GameObject picker)
 What happens when the weapon gets picked More...
 
override bool CheckIfPickable ()
 Checks if the object is pickable. More...
 
- Protected Member Functions inherited from MoreMountains.CorgiEngine.PickableItem
virtual void Start ()
 On Start we grab and store our components More...
 
virtual IEnumerator DisableTargetObjectCoroutine ()
 
virtual void Effects ()
 Triggers the various pick effects More...
 

Protected Attributes

CharacterHandleWeapon _characterHandleWeapon = null
 
- Protected Attributes inherited from MoreMountains.CorgiEngine.PickableItem
Collider2D _collider
 
Collider2D _pickingCollider
 
Renderer _renderer
 
Character _character = null
 
bool _pickable = false
 
ItemPicker _itemPicker = null
 
GameObject _collidingObject
 
AutoRespawn _autoRespawn
 

Additional Inherited Members

- Public Member Functions inherited from MoreMountains.CorgiEngine.PickableItem
virtual void OnTriggerEnter2D (Collider2D collider)
 Triggered when something collides with the coin More...
 
virtual void PickItem (GameObject picker)
 Check if the item is pickable and if yes, proceeds with triggering the effects and disabling the object More...
 

Detailed Description

Add this class to a collectible to have the player change weapon when collecting it

Member Function Documentation

◆ CheckIfPickable()

override bool MoreMountains.CorgiEngine.PickableWeapon.CheckIfPickable ( )
protectedvirtual

Checks if the object is pickable.

Returns
true

false

Reimplemented from MoreMountains.CorgiEngine.PickableItem.

◆ Pick()

override void MoreMountains.CorgiEngine.PickableWeapon.Pick ( GameObject  picker)
protectedvirtual

What happens when the weapon gets picked

Reimplemented from MoreMountains.CorgiEngine.PickableItem.

Member Data Documentation

◆ _characterHandleWeapon

CharacterHandleWeapon MoreMountains.CorgiEngine.PickableWeapon._characterHandleWeapon = null
protected

◆ HandleWeaponID

int MoreMountains.CorgiEngine.PickableWeapon.HandleWeaponID = 1

the ID of the CharacterHandleWeapon ability you want this weapon to go to (1 by default)

◆ WeaponToGive

Weapon MoreMountains.CorgiEngine.PickableWeapon.WeaponToGive

the new weapon the player gets when collecting this object


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