Rebornbuddy
Loading...
Searching...
No Matches
ff14bot.Behavior.HookDescription Class Reference

Represents a description of a hook, including its name and an optional description. More...

Public Member Functions

 HookDescription (string name, string description=null)
 Represents a description of a hook, including its name and an optional description.
bool Equals (HookDescription other)
 Compares the current HookDescription instance with another instance to determine equality.
override bool Equals (object obj)
 Determines whether the specified object is equal to the current instance.
override int GetHashCode ()
 Generates a hash code for the current instance.

Properties

string Name [get, set]
 Gets or sets the name associated with the hook description.
string Description [get, set]
 Gets or sets the description of the hook.

Detailed Description

Represents a description of a hook, including its name and an optional description.

Used to provide metadata about hooks, such as their name and purpose.

Constructor & Destructor Documentation

◆ HookDescription()

ff14bot.Behavior.HookDescription.HookDescription ( string name,
string description = null )

Represents a description of a hook, including its name and an optional description.

This class provides metadata about a hook, such as its name and purpose, to be used within TreeHooks functionality.

Member Function Documentation

◆ Equals() [1/2]

bool ff14bot.Behavior.HookDescription.Equals ( HookDescription other)

Compares the current HookDescription instance with another instance to determine equality.

Parameters
otherThe other HookDescription instance to compare with the current instance.
Returns
True if the instances are equal; otherwise, false.

◆ Equals() [2/2]

override bool ff14bot.Behavior.HookDescription.Equals ( object obj)

Determines whether the specified object is equal to the current instance.

Parameters
objThe object to compare with the current instance.
Returns
True if the specified object is equal to the current instance; otherwise, false.

◆ GetHashCode()

override int ff14bot.Behavior.HookDescription.GetHashCode ( )

Generates a hash code for the current instance.

Returns
A hash code for the current object.

Property Documentation

◆ Description

string ff14bot.Behavior.HookDescription.Description
getset

Gets or sets the description of the hook.

◆ Name

string ff14bot.Behavior.HookDescription.Name
getset

Gets or sets the name associated with the hook description.