koobas.hobune.stream
Need help using coroutines
Okay, so before I came to this place (again), I gave it a good go attempting to add coroutines to my flashlight script. I started coding in C# yesterday so there is bound to be tons of mistakes but if anybody could tell me how to clearly get this running in the way I want it to, that would be great. Its quite simple - I just want the flashlight to die after it has run out of energy, and the speed at which the flashlight will die to be defined by the user.
using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.UI; //this allows us to reference anything to do with the UI in our script. *MUST BE ADDED IN ORDER TO USE UI IN SCRIPTS*
public class flashlight2 : MonoBehaviour
{
public Light lightSource; //allows us to add a light source to be toggled.
public AudioClip soundOn; //allows us to add a sound to be played everytime the flashlight is turned on.
public AudioClip soundOff; //allows us to add a sound to be played everytime the flashlight is turned off.
public KeyCode key; //this will allow us to choose our desired key to toggle the flashlight outside of the script.
public Text isontext; //this is used as a reference to the text that will be updated by our script.
private bool isOn = false; //this will make the text display the light as being off at the beginning of the game, rather than displaying nothing.
public float currentBatteryLife = 100.0f; //this allows us to set the amount of energy that the flashlight has.
public float drainSpeed = 3.0f; //this is the speed that the energy drains at.
public float maxBatteryLife = 100.0f;
AudioSource lightaudio;
void Awake () //awake is used to initiate game states and variables before the game starts - this is only ran once during the script's lifetime. We only need to grab the audio source once, so we used awake to do so before anything else can happen.
{
lightaudio = GetComponent<AudioSource> (); //grabs the audio source component - allows sound to be played.
}
void Start () //Start is called on the frame when a script is enabled just before any of the Update methods is called the first time.
{
lightSource.enabled = false; //this will start the game with the flashlight off.
displaytext();
currentBatteryLife = maxBatteryLife;
}
void Update () //anything within the update function will be called/updated every frame.
{
if (Input.GetKeyDown (key)) //if the specified key (set in the Inspector) is pressed, then do the following
{
lightSource.enabled = !lightSource.enabled; //the "!" operator means not, you can toggle something by setting it to the opposite value of itself, which is what we are doing here with the light source. You can toggle a light source by toggling its enabled state.
isOn = !isOn; //the boolean isOn will be toggled when the specified key is pressed.
displaytext();
playsound ();
StartCoroutine (BatteryDrain (drainSpeed));
if (currentBatteryLife <= 0)
{
lightSource.enabled = false;
}
}
}
void displaytext () //using the same line of code more than once is inefficient, therefore I made the line of code a function, so instead of using that same line of code, I can call the function. This uses less memory.
{
isontext.text = "Light: " + isOn.ToString (); //the boolean variable isOn will be displayed on the screen whether it is true or false (testing text).
}
void playsound () //this function allows us to play a different sound when the flashlight is toggled on or off.
{
if (lightSource.enabled == true) //if the flashlight is on, then play the sound indicating that the flashlight has been toggled on.
lightaudio.PlayOneShot (soundOn);
if (lightSource.enabled == false) //if the flashlight is off, then play the sound indicating that the flashlight has been toggled off.
lightaudio.PlayOneShot (soundOff);
}
IEnumerator BatteryDrain(float time)
{
if (lightSource.enabled)
{
currentBatteryLife -= drainSpeed * Time.deltaTime;
}
}
}
Couroutines require yield statements, such as
yield return new WaitForSeconds (1f);
Time.deltaTime is only accessible within Update(). When you start a coroutine, it will happen independently form the main loop (not another thread though).
Unless the battery decreases step by step over a long period of time, I'd stay away from the coroutines for this.
You could use
InvokeRepeating ("BatteryDrain", t) // where t is the timestep
I would personally simply put this within Update () and would most probably make currentBatteryLife a property accessor to trigger things when it goes below any given value.
Hope this helps.
Sorry I tried using InvokeRepeating then the function, but I'm not familiar with timesteps. I see that InvokeRepeating requires 3 arguments to run, but I do not know what these timestesps need to be to have the battery drain. Also, I seem to be struggling with getting the BatteryDrain to even drain properly anyway - as I said, I'm very new to this stuff :)
