Key Object + Animations

[RotX18]

Credits

• Key and door were modelled by @chiitori (#32)
• Key and door animation was done by @RabbitKazma

Animations and interaction of the objects were done with this issue by @RotX18

Objective:

• [x] Key should be parented to Door
• [x] Key should trigger the animation in its OnTriggerEnter(Collision other) method
• [x] Door should open as the key triggers mentioned animation

[RotX18]

Key and door interaction

Logic is as follows:

1. Key spawns (#27)
2. Key has an _unlocked boolean that will trigger the animation when the bool is set to true and the player releases the object
3. When the key enters the DoorLock collider, the collider sets the unlocked boolean to true.
4. When the key is released, if the key is near the door lock, it is parented to the door and the animation plays

Code + description

Key.cs

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class Key : MonoBehaviour, IPickable
{
    #region PUBLIC VARS
    public Animator anim;
    public GameObject door;
    #endregion

    #region PRIVATE VARS
    private bool _unlock = false;
    private int _doorUnlock = Animator.StringToHash("DoorUnlock");
    #endregion

    #region PROPERTIES
    #region IPickable PROPERTIES
    public IPickable.Controller CurrentController {
        get;
        set;
    }

    public bool Grabbed {
        get;
        set;
    } = false;
    #endregion

    public bool Unlock {
        get {
            return _unlock;
        }
        set {
            _unlock = value;
        }
    }
    #endregion

    #region INTERFACE METHODS
    public void OnRelease(){ 
        if(_unlock && !Grabbed){
            gameObject.transform.SetParent(door.transform);
            anim.SetTrigger(_doorUnlock);
        }
    }
    #endregion
}

Description: Key implements IPickable to facilitate unlocking animation

• OnRelease():
  • When the player releases the key, does an if check to determine whether to play the unlock
  • if unlock is true, set the parent of the key to the doornkey object
• _unlock boolean that determines whether the animation plays OnRelease
• Unlock property to access _unlock

DoorLock.cs

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class DoorLock : MonoBehaviour
{
    private void OnTriggerEnter(Collider other) {
        if(other.name.Equals("Key")){
            other.GetComponent<Key>().Unlock = true;
        }
    }
}

Description:

• OnTriggerEnter():
  • if check to check for collision name
  • if the name of the colliding object is "Key" get Key component and set the Unlock property to true

Animation is bugged; Key does not animate when animation is triggered, to discuss with @RabbitKazma before updating issue and closing

[RabbitKazma]

Animation Key #80

• there is two keys now 1 in doornkey the other in the cabinet
• the player picks up the cabinet key and bring it to the doornkey collider
• when the player lets go of that key the animation would play with another key
• so there is a need to remove the first key @RotX18
• Key is the one in the cabinet. Key (1) is the animation under the parent doornkey.

[RotX18]

Completed door unlocking animation

Implemented suggestion by @RabbitKazma to use a pre-parented key to run the animation

Code changes

Key.cs (modified code)

#region INTERFACE METHODS
public void OnRelease(){ 
    if(_unlock){
        Destroy(gameObject);
    }
}

private void OnDestroy() {
    Debug.Log("PLAYING DOOR ANIM");
    anim.SetTrigger(_doorUnlock);
}
#endregion

Edits:

• Added:
  • OnDestroy():
  • Plays the animation when the key is destroyed
• Changed:
  • Moved animation trigger to OnDestroy instead of release to streamline code

NOTE: Will refactor, recommit and pull after this comment

Feature completed, issue will now be closed