Properties

Checked with version: 4.1

-

Difficulty: Intermediate

How to create properties to access the member variables (fields) in a class.

Properties

Intermediate Scripting

Player

Code snippet

using UnityEngine;
using System.Collections;

public class Player
{
    //Member variables can be referred to as
    //fields.
    private int experience;
    
    //Experience is a basic property
    public int Experience
    {
        get
        {
            //Some other code
            return experience;
        }
        set
        {
            //Some other code
            experience = value;
        }
    }
    
    //Level is a property that converts experience
    //points into the leve of a player automatically
    public int Level
    {
        get
        {
            return experience / 1000;
        }
        set
        {
            experience = value * 1000;
        }
    }
    
    //This is an example of an auto-implemented
    //property
    public int Health{ get; set;}
}
#pragma strict

public class Player
{
    //Member variables can be referred to as
    //fields.
    var experience : int;
    
    //Experience is a basic property
    public function get Experience() : int
    {
        return experience;
    }
    
    public function set Experience(value : int)
    {
        experience = value;
    }
    
    //Level is a property that converts experience
    //points into the leve of a player automatically
    public function get Level() : int
    {
        return experience / 1000;
    }
    
    public function set Level(value : int)
    {
        experience = value * 1000;
    }
    
    //Auto-implemented properties are not a feature of the
    //Javascript language.
}
import UnityEngine
import System.Collections


public class Player:

    //Member variables can be referred to as
    //fields.
    private experience as int

    
    //Experience is a basic property
    public Experience as int:
        get:
            //Some other code
            return experience
        set:
            //Some other code
            experience = value

    
    //Level is a property that converts experience
    //points into the leve of a player automatically
    public Level as int:
        get:
            return (experience / 1000)
        set:
            experience = (value * 1000)

    
    //This is an example of an auto-implemented
    //property
    public Health as int:
        get:
            pass
        set:
            pass

Game

Code snippet

using UnityEngine;
using System.Collections;

public class Game : MonoBehaviour 
{
    void Start () 
    {
        Player myPlayer = new Player();
        
        //Properties can be used just like variables
        myPlayer.Experience = 5;
        int x = myPlayer.Experience;
    }
}
#pragma strict

function Start () 
{
    var myPlayer = new Player();
    
    //Properties can be used just like variables
    myPlayer.Experience = 5;
    var x : int = myPlayer.Experience;
    
    print(x);
}
import UnityEngine
import System.Collections


public class Game(MonoBehaviour):

    private def Start():
        myPlayer = Player()
        
        //Properties can be used just like variables
        myPlayer.Experience = 5
        x as int = myPlayer.Experience

Related tutorials

Scripting

  1. Scripts as Behaviour Components
  2. Variables and Functions
  3. Conventions and Syntax
  4. C# vs JS syntax
  5. IF Statements
  6. Loops
  7. Scope and Access Modifiers
  8. Awake and Start
  9. Update and FixedUpdate
  10. Vector Maths
  11. Enabling and Disabling Components
  12. Activating GameObjects
  13. Translate and Rotate
  14. Look At
  15. Linear Interpolation
  16. Destroy
  17. GetButton and GetKey
  18. GetAxis
  19. OnMouseDown
  20. GetComponent
  21. Delta Time
  22. Data Types
  23. Classes
  24. Instantiate
  25. Arrays
  26. Invoke
  27. Enumerations
  28. Switch Statements
  1. Properties
  2. Ternary Operator
  3. Statics
  4. Method Overloading
  5. Generics
  6. Inheritance
  7. Polymorphism
  8. Member Hiding
  9. Overriding
  10. Interfaces
  11. Extension Methods
  12. Namespaces
  13. Lists and Dictionaries
  14. Coroutines
  15. Quaternions
  16. Delegates
  17. Attributes
  18. Events
  1. Building a Custom Inspector
  2. The DrawDefaultInspector Function
  3. Adding Buttons to a Custom Inspector
  1. MonoDevelop's Debugger
  2. Good Coding Practices in Unity
  3. Unity Editor Extensions – Menu Items
  4. Creating Meshes
  1. AssetBundles and the AssetBundle Manager
  2. Mastering Unity Project Folder Structure - Version Control Systems
  1. Installing Tools for Unity Development
  2. Building your first Unity Game with Visual Studio
  3. Editing Unity games in Visual Studio
  4. Debugging Unity games in Visual Studio
  5. Graphics debugging Unity games in Visual Studio
  6. Taking Unity games to Universal Windows Platform
  7. Testing Unity games on Android in Visual Studio
  1. Scripting Primer and Q&A
  2. Scripting Primer and Q&A - Continued
  3. Scripting Primer and Q&A - Continued (Again)
  4. Persistence - Saving and Loading Data
  5. Object Pooling
  6. Introduction to Scriptable Objects
  7. How to communicate between Scripts and GameObjects
  8. Coding in Unity for the Absolute Beginner
  9. Sound Effects & Scripting
  10. Editor Scripting Intro
  11. Writing Plugins
  12. Property Drawers & Custom Inspectors
  13. Events: Creating a simple messaging system
  14. Ability System with Scriptable Objects
  15. Character Select System with Scriptable Objects
  1. Intro and Setup
  2. Data Classes
  3. Menu Screen
  4. Game UI
  5. Answer Button
  6. Displaying Questions
  7. Click To Answer
  8. Ending The Game and Q&A
  1. Intro To Part Two
  2. High Score with PlayerPrefs
  3. Serialization and Game Data
  4. Loading Game Data via JSON
  5. Loading and Saving via Editor Script
  6. Game Data Editor GUI
  7. Question and Answer
  1. Overview and Goals
  2. Localization Data
  3. Dictionary, JSON and Streaming Assets
  4. Localization Manager
  5. Startup Manager
  6. Localized Text Component
  7. Localized Text Editor Script
  8. Localization Q&A
  1. Introduction and Session Goals
  2. Particle Launcher
  3. Particle Collisions
  4. ParticleLauncher Script
  5. Particle Collisions and Scripting
  6. Random Particle Colors
  7. Drawing Decals with Particles
  8. Collecting Particle Information For Display
  9. Displaying Particles Via Script
  10. Droplet Decals
  11. Questions and Answers