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.

Comments

Assets Worth Checking Out

POPULAR POSTS

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…

How To Animate A Fish Swimming With Shaders

Animate Fish Swimming With Shaders We are going to make swimming animation by using only shader code.
By the time we are done, it's going to look like this.
You will probably need the fish model used in this tutorial, that can be found HERE. Can use your own model but the shader code might have to be modified accordingly because of the orientation of the model that you might be using ( issues with whether the X axis & Z axis is flipped ).
The shader used way out performs a similar scene with skeletal animations applied on the fish models.
On a previous benchmark I did comparing the shader animation with the skeletal animation there was a difference of 28 FPS( on average ) with 50 fish.
The shader we are going to make is really powerful and flexible and don't think that it's limited to making fishes swim😀.


So this mesh oriented like this when imported into unity and this is important to understand because this means that the model's vertices have to be moved along the X-…

Pixelation Shader - Unity Shader

Pixelation Shader This is the correct way (one of many) of showing pixelation as a post-processing effect. This effect will work in any aspect ratio without any pixel size scaling issues as well as it is very minimal in terms of coding it up.

In order to get this to work 2 components have to be set up:
1) The pixelation image effect
2) The script - which will be attached to the camera

So let's get started by creating a new image effect shader.
We will take a look at our Shaderlab properties :
_MainTex("Texture", 2D) = "white" {} That's it, Everything else will be private and not shown in the editor.
Now we will see what are defined along with the _MainTex but are private.
sampler2D _MainTex; int _PixelDensity; float2 _AspectRatioMultiplier; We will pass _PixelDensity & _AspectRatioMultiplier values from the script.
As this is an image effect there is no need to play around with the vertex shader.
Let's take a look at our fragment shader:
fixed4 frag (…

Toon Liquid Shader - Unity Shader

Toon Liquid Shader This is how the shader will end up looking :
This shader is pretty neat and somewhat easy to implement as well as to understand. Since we will be adding some basic physics to the toon water as it is moved about we will have to support that in the vertex shader as well.
So let's start by looking at the properties :
Properties { _Colour ("Colour", Color) = (1,1,1,1) _FillAmount ("Fill Amount", Range(-10,10)) = 0.0 [HideInInspector] _WobbleX ("WobbleX", Range(-1,1)) = 0.0 [HideInInspector] _WobbleZ ("WobbleZ", Range(-1,1)) = 0.0 _TopColor ("Top Color", Color) = (1,1,1,1) _FoamColor ("Foam Line Color", Color) = (1,1,1,1) _Rim ("Foam Line Width", Range(0,0.1)) = 0.0 _RimColor ("Rim Color", Color) = (1,1,1,1) _RimPower ("Rim Power", Range(0,10)) = 0.0 } Just the usual stuff that we are used to. The only thing that may stand out is the [HideInInspector] tag, This works j…

Access Reflection Probe Data For Custom Shaders

The Unity shader documentation regarding reflection probes is pretty minimal and not at all comprehensive.
This short tutorial is intended to bring reflection probe functionalities to the forefront your future shader writing endevors which is a fancy way of saying "Look at this cool stuff and go and use it somewhere" 😏
Here we will try just the bare minimum of making a shader that reflects the cubemap data from reflection probe and displays it on the object.

These reflection probes are basically objects that store a complete image of the environment surrounding it into a cubemap which then can be read by shaders to create various effects.
More information on how reflection probes work in Unity can be found here :
Using Reflection Probes In Unity

I am not going over how to set up Reflection Probes here only how to access them inside our custom shaders.
So this is what we will be making:
The reflection probe takes in the cubemap only if it is within it's range otherwise i…