The base class for all Word Game Builder components. More...

Inheritance diagram for WGBBase:

Collaboration diagram for WGBBase:

Public Member Functions
T	GetComponentFromInterface< T > ()
	Gets a component from its interface type. More...

T	GetComponentInChildrenFromInterface< T > ()
	Gets a component from its interface type, searching through this GameObject and all children. More...

T[]	GetComponentsFromInterface< T > ()
	Gets all components from its interface type. More...

T[]	GetComponentsInChildrenFromInterface< T > ()
	Gets all components from its interface type, searching through this GameObject and all children. More...

Static Public Member Functions
static T	FindObjectOfTypeFromInterface< T > ()
	Finds the first object of interface type T. More...

static T[]	FindObjectsOfTypeFromInterface< T > ()
	Finds all objects of interface type T. More...

static T	InstantiateFromInterface< T > (T original)
	Instantiate a GameObject from interface type T. More...

static T	InstantiateFromInterface< T > (T original, Vector3 position, Quaternion rotation)
	Instantiate a GameObject from interface type T at the specified position and rotation. More...

static void	Log (object message, string prefix, string type)
	Logs a prefixed message. More...

static void	Log (object message, string prefix, string type, Object context)
	Logs a prefixed message, with context. More...

static void	LogError (object message, string prefix, string type)
	Logs a prefixed erorr. More...

static void	LogError (object message, string prefix, string type, Object context)
	Logs a prefixed exception, with context. More...

static void	LogException (System.Exception ex)
	Logs an exception. More...

static void	LogException (System.Exception ex, Object context)
	Logs an exception, with context. More...

static void	LogWarning (object message, string prefix, string type)
	Logs a prefixed warning. More...

static void	LogWarning (object message, string prefix, string type, Object context)
	Logs a prefixed warning, with context. More...

Properties
object	userData `[get, set]`
	Additional user data associated with this object. This is unused by default. More...

Detailed Description

The base class for all Word Game Builder components.

Member Function Documentation

static T FindObjectOfTypeFromInterface< T > ( )

inlinestatic

Finds the first object of interface type T.

Template Parameters

T	The interface type to find. Must be an IMonoBehaviour.

Returns: The first found object as an interface. Returns null if no objects were found.

Type Constraints

T	:	class
T	:	IMonoBehaviour

static T [] FindObjectsOfTypeFromInterface< T > ( )

inlinestatic

Finds all objects of interface type T.

Template Parameters

T	The interface type to find. Must be an IMonoBehaviour.

Returns: An array of found objects, as an interface. Returns an empty array if no objects were found.

Type Constraints

T	:	class
T	:	IMonoBehaviour

T GetComponentFromInterface< T > ( )

inline

Gets a component from its interface type.

Template Parameters

T	The interface type of the component. Must be an IMonoBehaviour.

Returns: The found object as an interface. Returns null if no object was found.

Type Constraints

T	:	class
T	:	IMonoBehaviour

T GetComponentInChildrenFromInterface< T > ( )

inline

Gets a component from its interface type, searching through this GameObject and all children.

Template Parameters

T	The interface type of the component. Must be an IMonoBehaviour.

Returns: The found object as an interface. Returns null if no object was found.

Type Constraints

T	:	class
T	:	IMonoBehaviour

T [] GetComponentsFromInterface< T > ( )

inline

Gets all components from its interface type.

Template Parameters

T	The interface type of the component. Must be an IMonoBehaviour.

Returns: An array of found objects, as an interface. Returns an empty array if no objects were found.

Type Constraints

T	:	class
T	:	IMonoBehaviour

T [] GetComponentsInChildrenFromInterface< T > ( )

inline

Gets all components from its interface type, searching through this GameObject and all children.

Template Parameters

T	The interface type of the component. Must be an IMonoBehaviour.

Returns: An array of found objects, as an interface. Returns an empty array if no objects were found.

Type Constraints

T	:	class
T	:	IMonoBehaviour

static T InstantiateFromInterface< T > ( T original )

inlinestatic

Instantiate a GameObject from interface type T.

Template Parameters

T	The interface type to instantiate. Must be an IMonoBehaviour.

Parameters

original The object to instantiate.

Returns: The instantiated object as an interface.

Type Constraints

T	:	class
T	:	IMonoBehaviour

static T InstantiateFromInterface< T >	(	T	original,
		Vector3	position,
		Quaternion	rotation
	)

inlinestatic

Instantiate a GameObject from interface type T at the specified position and rotation.

Template Parameters

T	The interface type to instantiate. Must be an IMonoBehaviour.

Parameters

original	The object to instantiate.
position	The position to instantiate the new object at.
rotation	The rotation to instantiate the new object at.

Returns: The instantiated object as an interface.

Type Constraints

T	:	class
T	:	IMonoBehaviour

static void Log	(	object	message,
		string	prefix,
		string	type
	)

inlinestatic

Logs a prefixed message.

Parameters

message	The message to log.
prefix	The prefix to log with the message.
type	An identifier formatted with the prefix.

static void Log	(	object	message,
		string	prefix,
		string	type,
		Object	context
	)

inlinestatic

Logs a prefixed message, with context.

Parameters

message	The message to log.
prefix	The prefix to log with the message.
type	An identifier formatted with the prefix.
context	Object to which the message applies.

static void LogError	(	object	message,
		string	prefix,
		string	type
	)

inlinestatic

Logs a prefixed erorr.

Parameters

message	The message to log.
prefix	The prefix to log with the message.
type	An identifier formatted with the prefix.

Here is the caller graph for this function:

static void LogError	(	object	message,
		string	prefix,
		string	type,
		Object	context
	)

inlinestatic

Logs a prefixed exception, with context.

Parameters

message	The message to log.
prefix	The prefix to log with the message.
type	An identifier formatted with the prefix.
context	Object to which the message applies.

static void LogException ( System.Exception ex )

inlinestatic

Logs an exception.

Parameters

ex	The exception to log.

Here is the caller graph for this function:

static void LogException	(	System.Exception	ex,
		Object	context
	)

inlinestatic

Logs an exception, with context.

Parameters

ex	The exception to log.
context	Object to which the message applies.

static void LogWarning	(	object	message,
		string	prefix,
		string	type
	)

inlinestatic

Logs a prefixed warning.

Parameters

message	The message to log.
prefix	The prefix to log with the message.
type	An identifier formatted with the prefix.

Here is the caller graph for this function:

static void LogWarning	(	object	message,
		string	prefix,
		string	type,
		Object	context
	)

inlinestatic

Logs a prefixed warning, with context.

Parameters

message	The message to log.
prefix	The prefix to log with the message.
type	An identifier formatted with the prefix.
context	Object to which the message applies.

Property Documentation

object userData

getset

Additional user data associated with this object. This is unused by default.

Implements IMonoBehaviour.

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation