Skip to main content

Unity C# Attributes


Attributes Used In Unity
An attribute is a declarative tag that conveys information about the behaviors of various elements like classes, methods, structures, enums etc. in the program.
An attribute is depicted by square ([ ]) brackets placed above the element it is meant for.
Attributes are used for adding metadata, such as information such as comments, description, methods and classes to a program. The .Net Framework provides two types of attributes: the pre-defined attributes and custom built attributes.
Syntax for specifying an attribute:
[attribute(positional_parameters, name_parameter = value, ...)]
element
We will go over the pre-defined attributes on another post.
For now let's go over the most useful custom attributes that Unity has, as you now have a basic knowledge of what attributes are.
DisallowMultipleComponent: Prevents the same component from being added to the same game object.
[DisallowMultipleComponent]
public class PlayerControl : MonoBehaviour
{ .....
  .....
}
RequireComponnent(typeof(MonoBehavior)): Makes sure to add the specified component to the game object as well. It's useful when you always need another component on the game object in order for this component to work.
[RequireComponent(typeof(PlayerControl))]
public class PlayerNetwork : MonoBehaviour
{
  .....
  .....
}
HideInInspector: The public field tagged with this attribute will not be shown in the inspector.
.
.
[HideInInspector]
 public float teamAlign = 0.0f;
 public int ammoCount = 30;
 public string playerName;
.
.
SerializeField: Displays a field in the inspector even if it is private.
.
.
[SerializeField] private float sensitivity = 5.0f;
[SerializeField] private float smoothing = 10.0f;
[SerializeField] private float speed = 20;
.
.
Header(string): Displays a heading text on top of the element it's applied on.
.
.
[SerializeField, Header("Connection Details")] private Text connectText;
[SerializeField] private GameObject player;
[SerializeField] private GameObject lobbyCamera;
.
.
Range(float min, float max): Displays a slider with the appropriate minimum and maximum value.
.
.
[SerializeField] private float sensitivity = 5.0f;
[SerializeField] private float smoothing = 10.0f;
[SerializeField, Range(0,30)] private float speed = 20;
.
.
ToolTip(string): Shows a tool tip while mouse hovers over the element
.
.
[SerializeField, Range(0,30), Tooltip("Speed Of Player")] private float speed = 20;
private Vector2 mouseLook;
private Vector2 smoothVec;
.
.
Hope you learnt something today.😁
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, C# or Unity development in general don't be shy and leave a message on my facebook page or down in the comments.
For more Unity tutorials, go HERE.
For More C# Tutorials, go HERE.

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…

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 …

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…

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-…