ff14bot.Helpers.Blacklist Class Reference

Provides functionality to manage a blacklist of entries, allowing for adding, checking, retrieving, and clearing blacklisted items. More...

Classes
class	BlacklistEntry
	Represents an entry in the blacklist. More...

Public Member Functions
delegate bool	EntryRemovalDelegate (BlacklistEntry entry)
	Delegate used to define a condition for removing entries from the blacklist.

Static Public Member Functions
static void	Add (uint guid, TimeSpan end, string reason="")
	Adds an entry to the blacklist with a specified duration and reason.
static bool	Contains (GameObject o)
	Checks if a specific game object is blacklisted.
static void	Add (GameObject obj, BlacklistFlags flags, TimeSpan duration, string reason="")
	Adds a game object to the blacklist with specified flags, duration, and reason.
static void	Add (uint guid, BlacklistFlags flags, TimeSpan duration, string reason="")
	Adds an entry to the blacklist with specified flags, duration, and reason.
static void	Clear (EntryRemovalDelegate del)
	Clears entries from the blacklist based on a specified condition.
static bool	Contains (GameObject o, BlacklistFlags flags)
	Checks if a specific game object is blacklisted with the specified flags.
static bool	Contains (uint guid, BlacklistFlags flags=BlacklistFlags.All)
	Checks if a specific entry is blacklisted with the specified flags.
static void	Flush ()
	Clears all entries from the blacklist.
static BlacklistEntry	GetEntry (GameObject o)
	Retrieves the blacklist entry associated with a specific game object.
static BlacklistEntry	GetEntry (uint guid)
	Retrieves the blacklist entry associated with a specific unique identifier.

Detailed Description

Provides functionality to manage a blacklist of entries, allowing for adding, checking, retrieving, and clearing blacklisted items.

Member Function Documentation

Add() [1/3]

void ff14bot.Helpers.Blacklist.Add ( GameObject obj, BlacklistFlags flags, TimeSpan duration, string reason = "" )

static

Adds a game object to the blacklist with specified flags, duration, and reason.

Parameters

obj	The game object to blacklist.
flags	The blacklist flags associated with the entry.
duration	The duration for which the object should remain blacklisted.
reason	The reason for blacklisting the object.

Add() [2/3]

void ff14bot.Helpers.Blacklist.Add ( uint guid, BlacklistFlags flags, TimeSpan duration, string reason = "" )

static

Adds an entry to the blacklist with specified flags, duration, and reason.

Parameters

guid	The unique identifier of the entry.
flags	The blacklist flags associated with the entry.
duration	The duration for which the entry should remain blacklisted.
reason	The reason for blacklisting the entry.

Add() [3/3]

void ff14bot.Helpers.Blacklist.Add ( uint guid, TimeSpan end, string reason = "" )

static

Adds an entry to the blacklist with a specified duration and reason.

Parameters

guid	The unique identifier of the entry.
end	The duration for which the entry should remain blacklisted.
reason	The reason for blacklisting the entry.

Clear()

void ff14bot.Helpers.Blacklist.Clear ( EntryRemovalDelegate del )

static

Clears entries from the blacklist based on a specified condition.

Parameters

del	The delegate defining the condition for removal.

Contains() [1/3]

bool ff14bot.Helpers.Blacklist.Contains ( GameObject o )

static

Checks if a specific game object is blacklisted.

Parameters

o	The game object to check.

Returns

True if the object is blacklisted; otherwise, false.

Contains() [2/3]

bool ff14bot.Helpers.Blacklist.Contains ( GameObject o, BlacklistFlags flags )

static

Checks if a specific game object is blacklisted with the specified flags.

Parameters

o	The game object to check.
flags	The blacklist flags to check against.

Returns

True if the object is blacklisted with the specified flags; otherwise, false.

Contains() [3/3]

bool ff14bot.Helpers.Blacklist.Contains ( uint guid, BlacklistFlags flags = BlacklistFlags::All )

static

Checks if a specific entry is blacklisted with the specified flags.

Parameters

guid	The unique identifier of the entry.
flags	The blacklist flags to check against.

Returns

True if the entry is blacklisted with the specified flags; otherwise, false.

EntryRemovalDelegate()

delegate bool ff14bot.Helpers.Blacklist.EntryRemovalDelegate

(

BlacklistEntry

entry

)

Delegate used to define a condition for removing entries from the blacklist.

Parameters

entry

The blacklist entry to evaluate.

Returns

True if the entry should be removed; otherwise, false.

Flush()

void ff14bot.Helpers.Blacklist.Flush ( )

static

Clears all entries from the blacklist.

GetEntry() [1/2]

BlacklistEntry ff14bot.Helpers.Blacklist.GetEntry ( GameObject o )

static

Retrieves the blacklist entry associated with a specific game object.

Parameters

o	The game object to retrieve the entry for.

Returns

The blacklist entry if found; otherwise, null.

GetEntry() [2/2]

BlacklistEntry ff14bot.Helpers.Blacklist.GetEntry ( uint guid )

static

Retrieves the blacklist entry associated with a specific unique identifier.

Parameters

guid	The unique identifier of the entry.

Returns

The blacklist entry if found; otherwise, null.