Crosstales.BWF.Manager.BaseManager< S, T > Class Template Reference

Base class for all managers. More...

Inheritance diagram for Crosstales.BWF.Manager.BaseManager< S, T >:
Crosstales.Common.Util.Singleton< S >

Public Member Functions

string Unmark (string text, string prefix="<b><color=red>", string postfix="</color></b>")
 Unmarks the text with a prefix and postfix. More...
 

Public Attributes

bool isReady => _filter != null && _filter.isReady
 Checks the readiness status of the manager. More...
 

Protected Member Functions

void onContainsComplete (string text, bool result)
 
void onGetAllComplete (string text, System.Collections.Generic.List< string > badWords)
 
void onReplaceAllComplete (string originalText, string cleanText)
 
- Protected Member Functions inherited from Crosstales.Common.Util.Singleton< S >
virtual void Awake ()
 
virtual void OnDestroy ()
 
virtual void OnApplicationQuit ()
 

Protected Attributes

_filter
 

Properties

bool DisableOrdering [get, set]
 
abstract OnContainsCompleted onContainsCompleted [get]
 
abstract OnGetAllCompleted onGetAllCompleted [get]
 
abstract OnReplaceAllCompleted onReplaceAllCompleted [get]
 
- Properties inherited from Crosstales.Common.Util.Singleton< S >
static T Instance [get, protected set]
 Returns the singleton instance of this class. More...
 
bool DontDestroy [get, set]
 Don't destroy gameobject during scene switches. More...
 

Events

ContainsComplete OnContainsComplete
 An event triggered whenever the "Contains"-operation is completed. More...
 
GetAllComplete OnGetAllComplete
 An event triggered whenever the "GetAll"-operation is completed. More...
 
ReplaceAllComplete OnReplaceAllComplete
 An event triggered whenever the "ReplaceAll"-operation is completed. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Crosstales.Common.Util.Singleton< S >
static void CreateInstance (bool searchExistingGameObject=true, bool deleteExistingInstance=false)
 Creates an instance of this object. More...
 
static void DeleteInstance ()
 Deletes the instance of this object. More...
 
- Static Public Attributes inherited from Crosstales.Common.Util.Singleton< S >
static string PrefabPath
 Fully qualified prefab path. More...
 
static string GameObjectName
 Name of the gameobject in the scene. More...
 
- Static Protected Attributes inherited from Crosstales.Common.Util.Singleton< S >
static T instance
 

Detailed Description

Base class for all managers.

Member Function Documentation

◆ Unmark()

string Crosstales.BWF.Manager.BaseManager< S, T >.Unmark ( string  text,
string  prefix = "<b><color=red>",
string  postfix = "</color></b>" 
)

Unmarks the text with a prefix and postfix.

Parameters
textText with marked bad words
prefixPrefix for every found bad word (default: bold and red, optional)
postfixPostfix for every found bad word (default: bold and red, optional)
Returns
Text with unmarked bad words

Member Data Documentation

◆ isReady

bool Crosstales.BWF.Manager.BaseManager< S, T >.isReady => _filter != null && _filter.isReady

Checks the readiness status of the manager.

Returns
True if the manager is ready.

Event Documentation

◆ OnContainsComplete

ContainsComplete Crosstales.BWF.Manager.BaseManager< S, T >.OnContainsComplete

An event triggered whenever the "Contains"-operation is completed.

◆ OnGetAllComplete

GetAllComplete Crosstales.BWF.Manager.BaseManager< S, T >.OnGetAllComplete

An event triggered whenever the "GetAll"-operation is completed.

◆ OnReplaceAllComplete

ReplaceAllComplete Crosstales.BWF.Manager.BaseManager< S, T >.OnReplaceAllComplete

An event triggered whenever the "ReplaceAll"-operation is completed.


The documentation for this class was generated from the following file:
  • C:/Users/slaub/Unity/assets/BWFPro/BWFPro/Assets/Plugins/crosstales/BadWordFilter/Scripts/Manager/BaseManager.cs