Composite Class

Composite Class

The base class of the entire behavior tree system. Nearly all branches derive from this class.

Inheritance Hierarchy

Namespace: Styx.TreeSharp
Assembly: Styx.TreeSharp (in Styx.TreeSharp.dll) Version: 3.0.1160.0 (3.0.1160)

Syntax

public abstract class Composite : IEquatable<Composite>

The Composite type exposes the following members.

Constructors

	Name	Description
	Composite	Initializes a new instance of the Composite class

Properties

	Name	Description
	CleanupHandlers
	ContextChanger
	Guid	Gets a unique identifier.
	IsRunning	Returns true if the current behavior is running.
	LastStatus	Contains the execution status (if any) provided by the last Tick()
	Parent	Gets or sets the parent.

Methods

	Name	Description
	Cleanup
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Overrides ObjectEquals(Object).)
	Equals(Composite)	Indicates whether the current object is equal to another object of the same type.
	Execute
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Overrides ObjectGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Start	Initializes the Task into a runnable state by clearing the LastStatus (if any), clearing the cleanup handlers remaining (if any -- note that this may also trigger the IDisposable behavior of any remaining cleanup handlers on the cleanup stack), and reinitializing the execution enumerator.
	Stop	Stop will call all cleanup handlers!
	Tick	Executes the user code of the function, as expressed in Execute()
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Operators

	Name	Description
	Equality	Equality operator.
	Inequality	Inequality operator.

Fields

	Name	Description
	Locker	Provides a lockable object so we can gain a mutex over the operations done in Tick(...)

Extension Methods

	Name	Description
	ExecuteCoroutine	Executes the composite inside a coroutine. (Defined by CoroutineCompositeExtensions.)