Skip to main content

C# Fundamentals - Events

Events

To understand what Events are you have to know what Delegates are and how they function ( that was actually a pun - learn and come back ), A brief tutorial on Delegates can be found HERE.
Events can be stuff like key presses, player deaths, achievement unlocks, clicks,  mouse movements, etc..., or something like system generated notifications like window resize or minimize.
Events are just basically delegates with some extra protection stuff thrown in to prevent accidents.
We will go over these 'accidents' later on in this tutorial.
Events unlike delegates can not be declared outside the class body  as it is an instance of a delegate and instances can not exist outside a class body. These events are associated with event handlers by using delegates which may exist in the same class or some other class.
The class which contains the event notifies all other class about whether the event occurred.
This class is called the 'Publisher' class. Those classes that accept the event are known as a 'Subscriber' class.
Events greatly improve code quality in a number of ways:
  • Improves modularity of code.
  • Improves the 'One Class, One Job' aspect of the code.
  • Improves code maintainability if used reasonably 😛.
Syntax:
[<modifiers>] event [Delegate Type] <Name>
There are some things that Events prevents us from doing that provides additional protection from ourselves while writing code. The basic functionality of an Event can be done by just using a delegate but that leads to various situations that are undesirable like:
  • When assigning a delegate directly to a method all previous chaining of  methods are now removed.So to prevent this Events only use += & -= and no direct assignment.
  • Delegates can be called directly from the object that it's a part of, Like 'classObj.myDelegate()'. But Events do not allow that and prevents a lot of situations where you might shoot yourself in the foot.
Let's now look at a real-world example of how this might be used:
using System;

namespace Rextester
{
    public class GameManager
    {        
        public void AddPlayer(Player player)
        {
            player.achievementUnlocked += ShowAchievements;
            player.lostGame += PlayerLost;
        }
        private void ShowAchievements(Player player)
        {
            Console.WriteLine("Got Achievement : " + player.name);
        }
        private void PlayerLost(Player player)
        {
            player.achievementUnlocked -= ShowAchievements;
            player.lostGame -= PlayerLost;
            Console.WriteLine(player.name + " lost and is no longer in game");
        }
    }
    public class Player
    {
        public delegate void PlayerDelegate(Player player);
        public event PlayerDelegate achievementUnlocked;
        public event PlayerDelegate lostGame;
        
        private string name = "";
        public Player(string name) { this.name = name; }
        public void GotAchievement()
        {
            if(achievementUnlocked != null)
                achievementUnlocked(this);
        }
        public void LostGame()
        {
            if(lostGame != null)
                lostGame(this);
        }
    }
    
    public class Program
    {
        public static void Main(string[] args)
        {
           GameManager gameManager = new GameManager();
            
           Player player1 = new Player("Rick");
           Player player2 = new Player("Morty");
           Player player3 = new Player("Hideo Kojima");            
           
           gameManager.AddPlayer(player1);
           gameManager.AddPlayer(player2);
           gameManager.AddPlayer(player3);
            
           player1.GotAchievement();
           player2.GotAchievement();
           player3.GotAchievement();
            
           player2.LostGame();
            
           player1.GotAchievement();
           player2.GotAchievement();
           player3.GotAchievement();
            
           player1.LostGame();
            
           player1.GotAchievement();
           player2.GotAchievement();
           player3.GotAchievement();
        }
    }
}
Output :
Got Achievement : Rick
Got Achievement : Morty
Got Achievement : Hideo Kojima
Morty lost and is no longer in game
Got Achievement : Rick
Got Achievement : Hideo Kojima
Rick lost and is no longer in game
Got Achievement : Hideo Kojima
We will now break down all the important bits.
First the Player class:
public class Player
{
    public delegate void PlayerDelegate(Player player);
    public event PlayerDelegate achievementUnlocked;
    public event PlayerDelegate lostGame;
        
    private string name = "";
    public Player(string name) { this.name = name; }
    public void GotAchievement()
    {
        if(achievementUnlocked != null)
             achievementUnlocked(this);
    }
    public void LostGame()
    {
        if(lostGame != null)
             lostGame(this);
    }
}
We declared a delegate called PlayerDelegate which returns void and takes parameter of  Player.
Then we declared two events, both of same delegate type, one for when an achievement is unlocked and another when the player losses the game.
public void GotAchievement()
{
    if(achievementUnlocked != null)
          achievementUnlocked(this);
}
public void LostGame()
{
    if(lostGame != null)
          lostGame(this);
}
We are invoking each of the events but before we do, we are checking if anything is actually subscribed to it; That's why the null check is there.
Now time to look at the GameManager class:
public class GameManager
{        
    public void AddPlayer(Player player)
    {
        player.achievementUnlocked += ShowAchievements;
        player.lostGame += PlayerLost;
    }
    private void ShowAchievements(Player player)
    {
        Console.WriteLine("Got Achievement : " + player.name);
    }
    private void PlayerLost(Player player)
    {
        player.achievementUnlocked -= ShowAchievements;
        player.lostGame -= PlayerLost;
        Console.WriteLine(player.name + " lost and is no longer in game");
    }
}
We have a public AddPlayer method which takes in a Player object and then makes the 'ShowAchievemets' & 'PlayerLost' method subscribe to it.
Now let's take a closer look at the 'PlayerLost' method.
private void PlayerLost(Player player)
{
    player.achievementUnlocked -= ShowAchievements;
    player.lostGame -= PlayerLost;
    Console.WriteLine(player.name + " lost and is no longer in game");
}
This method takes in a player and unsubscribes it from the two methods, so after this, any calls from 'achievementUnlocked' & 'lostGame' will not invoke the ShowAchievements & PlayerLost method unless the player object is added back to the GameManager again as well.
So now you know a little bit more ( hopefully ) about how  Events in C# work.
For More C# Tutorials, go HERE.
Support Bitshift Programmer by leaving a like on Bitshift Programmer Facebook Page and be updated as soon as there is a new blog post.
If you have any questions that you might have about shaders or unity development in general don't be shy and leave a message on my facebook page or down in the comments.

Assets Worth Checking Out

POPULAR POSTS

Introduction To Replacement Shaders & Shader Keywords

What is a replacement shader? A replacement shader is a shader that gets applied to every object being rendered.
Since the camera determines what objects end up being shown on screen, The functionality for setting up replacement shaders are in the camera class as well.

A good use case of a replacement shader would be in making effects like SSAO.
Here we need access to the normals and the depth information so a replacement shader that displays only the normals can be rendered ( stored in a render texture ) and then another shader that displays the depth information ( stored in a render texture ) and then the final image is rendered with the SSAO effect by taking the two render textures as input and doing a bunch of calculations.

Another use case would be to visualize the environment differently for various reasons like how they did in City Skylines.

The function that performs shader replacement is:
Camera.SetReplacementShader( Shader shader, string replacementTag ) Takes in a shader as …

Curved Surface Shader [ Unity Implementation ]

Curved Surface Shader This is the shader that we will be having at the end of this tutorial.
 The curved surface shader is capable of achieving really varied visual effects from showing space-time curve due to gravity to a generic curved world shader that is seen in endless runners like Subway Surfers.
The concepts that you learn here can open you up to a new way of looking at shaders and if you didn't think they were the coolest thing ever already, hopefully let this be the turning point.😝.

Both the examples show above use the same exact material is just that different values have been passed to the shader.
Start by creating a new unlit shader in Unity and we will work our way from there.
First we define what the properties are:
_MainTex("Texture", 2D) = "white" {} _BendAmount("Bend Amount", Vector) = (1,1,1,1) _BendOrigin("Bend Origin", Vector) = (0,0,0,0) _BendFallOff("Bend Falloff", float) = 1.0 _BendFallOffStr("Falloff s…

Noise Generation Algorithms : White Noise With Shader Example

White Noise Many of you may know what white noise is and how it can be used in code.
But there are a spectrum of  'Coloured Noises' as well these include ones like brown noise, pink, blue and violet noise all these have slightly different properties and can be very useful in creating different effects. More details on coloured noises can be found HERE.
A lot of movies as well as video games like City Skylines use white noise to add a feeling of realism and texture to the on screen content, it's also referred to as a grain filter or overlay. It is a really subtle effect and should not be over used.
Creating white noise boils down to the random function used.
While writing C++ code or C# code we have access to good pseudo-random functions from their standard libraries... but while writing code in shaders we usually have to create our own pseudo-random number generator.
One really good way of making one is by using the frac( in Unity & HLSL ) or fract( in GLSL ) functio…

Alto's Adventure Style Procedural Surface Generation Part 1

Alto's Adventure Style - Procedural Surface Generation This game appears to be a strictly 2D game but if you have played it enough you will notice that some of the art assets used look like it's 3D ( I don't know if they are tho ). If you haven't played the game you are missing out on one the most visually pleasing and calming games out there ( There is literally a mode called Zen mode in the game ).
Anyway, I am going to show you how to make a procedural 2D world ( without the trees, buildings and background ) like in Alto's Adventure.
But you may notice I have a plane which is in in the Z-axis giving a depth to the surface which is not there in Alto's Adventure but if you want to know how to do it then that will be in part 2.
To achieve the same effect of Alto's Adventure ( I'm leaving that up to you ) only minimal changes are needed to the code that I am going to explain.
We are going to be using the plane mesh in unity for creating the 2D surface as th…

Making An Audio Visualizer In Unity With Blend Shapes & Audio API - Part 1

Audio Visualizer with Unity Audio API & Blend Shapes This tutorial is going to be split into two parts, The first part (this one) we are going to be covering Blendshapes, what they are, what it's used for and how to use them in Unity and in Part 2 we will cover integrating that with Unity's audio API to get the desired result.
So now you got a feel as to what we will be making.
Blendshapes are just like transitions that the vertices go through to go from being in one position in space to another with the help of a transition value. All the major 3d modelling software from Blender to Maya has it.
As you can see that the model has 2 shape keys, one called MinValue and another called MaxValue, these names don't carry over into unity but the index of the shape key( blend shape ) matters.
We will be manipulating the MaxValue to make changes to the mesh.
This is how the model looks when it has it's MaxValue set at zero.
You may have guessed now that it is just a basic linear i…