C# Class MBObject, Pharos

Base class that all Magical Box components (except particles) inherit from

Inheritance: MonoBehaviour, System.IComparable

显示文件 Open project: rstaewen/Pharos Class Usage Examples

Public Properties

Property	Type	Description
Muted	bool
Scale	Vector3

Protected Properties

Property	Type	Description
mChildren	List
mParent	MBObject,
mParticleSystem	MBParticleSystem,
mTransform	Transform

Public Methods

Method	Description
CompareTo ( object obj ) : int
Destroy ( ) : void	Destroys this object Because all Magical Box objects are part of a cached particle system hierarchy, you need to call this instead of just deleting the GameObject
Matches ( ) : bool	Gets whether class is of one of the given types
Purge ( ) : void	Recursively clear resources. Useful for parameters that load textures etc... This is called by the editor when you export to a prefabs and on Reset()
Reset ( ) : void
SetParent ( MBObject, parent ) : void	Sets a new parent for this object
mbReloadHierarchy ( ) : void	Force this object and all child objects to refetch parent and reload/recache their stuff This is used to update the cached hierarchy after changes were made
this ( int childIndex ) : MBObject,	Gets a child by its index
this ( string childName ) : MBObject,	Gets a child by its name

Protected Methods

Method	Description
OnDisable ( ) : void
OnDrawGizmos ( ) : void	By default draw the corresponding gizmo icon (with name of TypeName) ShouldDrawGizmos returns whether gizmos should be drawn or not, depending of the current editor settings
OnDrawGizmosSelected ( ) : void	By default draw the corresponding gizmo icon (with name of TypeName) ShouldDrawGizmos returns whether gizmos should be drawn or not, depending of the current editor settings
OnEnable ( ) : void

Method Details

CompareTo() public method

public CompareTo ( object obj ) : int
obj	object
return	int

Destroy() public method

Destroys this object

Because all Magical Box objects are part of a cached particle system hierarchy, you need to call this instead of just deleting the GameObject

public Destroy ( ) : void
return	void

Matches() public method

Gets whether class is of one of the given types

public Matches ( ) : bool
return	bool

OnDisable() protected method

protected OnDisable ( ) : void
return	void

OnDrawGizmos() protected method

By default draw the corresponding gizmo icon (with name of TypeName)

ShouldDrawGizmos returns whether gizmos should be drawn or not, depending of the current editor settings

protected OnDrawGizmos ( ) : void
return	void

OnDrawGizmosSelected() protected method

By default draw the corresponding gizmo icon (with name of TypeName)

ShouldDrawGizmos returns whether gizmos should be drawn or not, depending of the current editor settings

protected OnDrawGizmosSelected ( ) : void
return	void

OnEnable() protected method

protected OnEnable ( ) : void
return	void

Purge() public method

Recursively clear resources. Useful for parameters that load textures etc...

This is called by the editor when you export to a prefabs and on Reset()

public Purge ( ) : void
return	void

Reset() public method

public Reset ( ) : void
return	void

SetParent() public method

Sets a new parent for this object

public SetParent ( MBObject, parent ) : void
parent	MBObject,
return	void

mbReloadHierarchy() public method

Force this object and all child objects to refetch parent and reload/recache their stuff

This is used to update the cached hierarchy after changes were made

public mbReloadHierarchy ( ) : void
return	void

this() public method

Gets a child by its index

public this ( int childIndex ) : MBObject,
childIndex	int
return	MBObject,

this() public method

Gets a child by its name

public this ( string childName ) : MBObject,
childName	string
return	MBObject,

Property Details

Muted public_oe property

Whether this object is muted or not

Muted objects won't be processed and rendered

public bool Muted
return	bool

Scale public_oe property

Gets or sets object's scale

public Vector3 Scale
return	Vector3

mChildren protected_oe property

protected List mChildren
return	List

mParent protected_oe property

protected MBObject, mParent
return	MBObject,

mParticleSystem protected_oe property

protected MBParticleSystem, mParticleSystem
return	MBParticleSystem,

mTransform protected_oe property

protected Transform mTransform
return	Transform