Hydrogen.Components Class Reference

Additional static functions and constants used to extend existing Component support inside of Unity. More...

Static Public Member Functions
static T	AddComponent< T > (this GameObject targetObject, T cachedReference)
	Adds a component to a GameObject, if that component is not already present. More...
static T	GetComponentIfNull< T > (this Component targetObject, T cachedReference)
	Get a component reference, checking if its already referenced. More...
static T	GetComponentIfNull< T > (this GameObject targetObject, T cachedReference)
	Get a component reference, checking if its already referenced. More...
static T	GetComponentInParents< T > (this GameObject targetObject, T cachedReference)
	Get a component reference from a gameObjects parents. More...
static bool	HasComponent< T > (this GameObject targetObject, T cachedReference)
	Does the GameObject have the component? More...

Public Attributes
const string	DefaultSingletonName = "Hydrogen"
	The GameObject name used when creating singletons automatically via any of the Hydrogen components. More...

Detailed Description

Additional static functions and constants used to extend existing Component support inside of Unity.

Definition at line 37 of file Components.cs.

Member Function Documentation

static T Hydrogen.Components.AddComponent< T > ( this GameObject  targetObject, T  cachedReference  )

static

Adds a component to a GameObject, if that component is not already present.

Returns

The desired component.

Parameters

targetObject	The root object to add the component to.
cachedReference	Possible pre-existing reference to component.

Template Parameters

T	Object Type.

private AudioSource _localAudioSource = null; public void Start() { _localAudioSource = gameObject.AddComponent<AudioSource>(_localAudioSource); }

Type Constraints

T

:

Component

Definition at line 58 of file Components.cs.

                                                                                                          : Component
                {
                        if (cachedReference != null) {
                                return cachedReference;
                        }

                        T component = (T)targetObject.GetComponent (typeof(T)) ?? (T)targetObject.AddComponent (typeof(T));

                        return component;
                }

static T Hydrogen.Components.GetComponentIfNull< T > ( this Component  targetObject, T  cachedReference  )

static

Get a component reference, checking if its already referenced.

Returns

The desired component.

Parameters

targetObject	The object to look on for the component.
cachedReference	Possible pre-existing reference to component.

Template Parameters

T	Object Type.

private AudioSource _localAudioSource = null; public AudioSource LocalAudioSource { get { _localAudioSource = Hydrogen.Components.GetComponentIfNull( this, _localAudioSource ); return _localAudioSource; } }

Type Constraints

T

:

Component

Definition at line 87 of file Components.cs.

                                                                                                                 : Component
                {
                        if (cachedReference == null) {
                                cachedReference = (T)targetObject.GetComponent (typeof(T));
                                if (cachedReference == null) {
                                        Debug.LogWarning ("GetComponent of type " + typeof(T) + " failed on " + targetObject.name, targetObject);
                                }
                        }
        
                        return cachedReference;
                }

static T Hydrogen.Components.GetComponentIfNull< T > ( this GameObject  targetObject, T  cachedReference  )

static

Get a component reference, checking if its already referenced.

Returns

The desired component.

Parameters

targetObject	The object to look on for the component.
cachedReference	Possible pre-existing reference to component.

Template Parameters

T	Object Type.

private AudioSource _localAudioSource = null; public AudioSource LocalAudioSource { get { _localAudioSource = Hydrogen.Components.GetComponentIfNull( this, _localAudioSource ); return _localAudioSource; } }

Type Constraints

T

:

Component

Definition at line 117 of file Components.cs.

                                                                                                                  : Component
                {
                        if (cachedReference == null) {
                                cachedReference = (T)targetObject.GetComponent (typeof(T));
                                if (cachedReference == null) {
                                        Debug.LogWarning ("GetComponent of type " + typeof(T) + " failed on " + targetObject.name, targetObject);
                                }
                        }
        
                        return cachedReference;
                }

static T Hydrogen.Components.GetComponentInParents< T > ( this GameObject  targetObject, T  cachedReference  )

static

Get a component reference from a gameObjects parents.

Returns

The desired component.

Parameters

targetObject	The root object to look on for the component (backwards).
cachedReference	Possible pre-existing reference to component.

Template Parameters

T	Object Type.

private AudioSource _localAudioSource = null; public AudioSource LocalAudioSource { get { _localAudioSource = Hydrogen.Components.GetComponentInParents( this, _localAudioSource ); return _localAudioSource; } }

Type Constraints

T

:

Component

Definition at line 147 of file Components.cs.

                                                                                                                     : Component
                {
                        if (cachedReference == null) {
                                Transform p = targetObject.transform.parent;

                                while (p != null) {
                                        var t = (T)targetObject.GetComponent (typeof(T));
                    
                                        // Return as soon as we find the component
                                        if (t != null) {
                                                cachedReference = t;
                                                return cachedReference;
                                        }
                    
                                        // Next parent to search
                                        p = p.parent;
                                }

                                if (cachedReference == null) {
                                        Debug.LogWarning ("GetComponentInParents of type " + typeof(T) + " failed on " + targetObject.name, targetObject);
                                }
                        }
            
                        return cachedReference;
                }

static bool Hydrogen.Components.HasComponent< T > ( this GameObject  targetObject, T  cachedReference  )

static

Does the GameObject have the component?

Returns

If the component is added to the GameObject

Parameters

targetObject	The root object to look on for the component.
cachedReference	Possible pre-existing reference to component.

Template Parameters

T	Object Type.

private AudioSource _localAudioSource = null; public void Start() { if (gameObject.HasComponent(_localAudioSource) == false) { _localAudioSource = gameObject.AddComponent<AudioSource>(); } }

Type Constraints

T

:

Component

Definition at line 190 of file Components.cs.

                                                                                                             : Component
                {
                        return cachedReference != null || targetObject.GetComponent (typeof(T)) != null;
                }

Member Data Documentation

const string Hydrogen.Components.DefaultSingletonName = "Hydrogen"

The GameObject name used when creating singletons automatically via any of the Hydrogen components.

Definition at line 42 of file Components.cs.