AManagerClass

From Unify Community Wiki
(Difference between revisions)
Jump to: navigation, search
(Boo - AManager.boo)
(Boo - AManager.boo)
Line 54: Line 54:
 
   
 
   
 
  class AManager (MonoBehaviour) :
 
  class AManager (MonoBehaviour) :
  """AManager is a singleton.
+
  """
 +
AManager is a singleton.
 
  To avoid having to manually link an instance to every class that needs it, it has a static property called
 
  To avoid having to manually link an instance to every class that needs it, it has a static property called
 
  instance, so other objects that need to access it can just call:
 
  instance, so other objects that need to access it can just call:
 
         AManager.instance.DoSomeThing()
 
         AManager.instance.DoSomeThing()
 
  """
 
  """
 +
 
     # s_Instance is used to cache the instance found in the scene so we don't have to look it up every time.
 
     # s_Instance is used to cache the instance found in the scene so we don't have to look it up every time.
 
     private static s_Instance : AManager = null
 
     private static s_Instance : AManager = null

Revision as of 06:59, 1 December 2005

Author Keli Hlodversson (freyr)

Contents

Description

The following snippet shows how to add a static property called instance that will automatically find an instance of the class in the scene and return it.

This is useful for managers and other behaviours that only have one instance in the scene and need to be accessed from other classes, as it avoids having each class to keep a reference to the manager object.

Usage

Use the code example as a template when creating a manager-type script.

C# - AManager.cs

using UnityEngine;
using System.Collections; 

/// AManager is a singleton.
/// To avoid having to manually link an instance to every class that needs it, it has a static property called
/// instance, so other objects that need to access it can just call:
///        AManager.instance.DoSomeThing();
///
public class AManager : MonoBehaviour {
   // s_Instance is used to cache the instance found in the scene so we don't have to look it up every time.
   private static AManager s_Instance = null;

   // This defines a static instance property that attempts to find the manager object in the scene and
   // returns it to the caller.
   public static AManager instance {
       get {
           if (s_Instance == null) {
               // This is where the magic happens.
               //  FindObjectOfType(...) returns the first AManager object in the scene.
               s_Instance =  FindObjectOfType(typeof (AManager)) as AManager;
               if (s_Instance == null)
                   Debug.Log ("Could not locate an AManager object. \
                                       You have to have exactly one AManager in the scene.");
           }
           
           return s_Instance;
       }
   }
   
   // Add the rest of the code here...
   public void DoSomeThing() {
       Debug.Log("Doing something now", this);
   }
 
}

Boo - AManager.boo

import UnityEngine

class AManager (MonoBehaviour) :
"""
AManager is a singleton.
To avoid having to manually link an instance to every class that needs it, it has a static property called
instance, so other objects that need to access it can just call:
       AManager.instance.DoSomeThing()
"""

   # s_Instance is used to cache the instance found in the scene so we don't have to look it up every time.
   private static s_Instance : AManager = null

   #This defines a static instance property that attempts to find the manager object in the scene and
   # returns it to the caller.
   public static instance :
       get :
           if s_Instance == null :
               # This is where the magic happens.
               #  FindObjectOfType(...) returns the first AManager object in the scene.
               s_Instance =  FindObjectOfType(AManager) 
               if s_Instance == null:
                   Debug.Log ("Could not locate an AManager object. \
                                       You have to have exactly one AManager in the scene.")
           
           return s_Instance

   # Add the rest of the code here...
   public DoSomeThing() :
       Debug.Log("Doing something now", self)
Personal tools
Namespaces

Variants
Actions
Navigation
Extras
Toolbox