Crosstales.BWF.Manager.CapitalizationManager Class Reference

Manager for excessive capitalization. More...

Inheritance diagram for Crosstales.BWF.Manager.CapitalizationManager:

Public Member Functions
void	Load ()
	Loads the current filter with all settings from this object. More...
bool	Contains (string text)
	Searches for excessive capitalizations in a text. More...
void	ContainsAsync (string text)
	Searches asynchronously for excessive capitalizations in a text. Use the "OnContainsComplete"-callback to get the result. More...
System.Collections.Generic.List< string >	GetAll (string text)
	Searches for excessive capitalizations in a text. More...
void	GetAllAsync (string text)
	Searches asynchronously for excessive capitalizations in a text. Use the "OnGetAllComplete"-callback to get the result. More...
string	ReplaceAll (string text, bool markOnly=false, string prefix="", string postfix="")
	Searches and replaces all excessive capitalizations in a text. More...
void	ReplaceAllAsync (string text, bool markOnly=false, string prefix="", string postfix="")
	Searches and replaces asynchronously all domains in a text. Use the "OnReplaceAllComplete"-callback to get the result. More...
string	Mark (string text, bool replace=false, string prefix="<b><color=red>", string postfix="</color></b>")
	Marks the text with a prefix and postfix. More...
Public Member Functions inherited from Crosstales.BWF.Manager.BaseManager< CapitalizationManager, CapitalizationFilter >
string	Unmark (string text, string prefix="<b><color=red>", string postfix="</color></b>")
	Unmarks the text with a prefix and postfix. More...

Static Public Member Functions
static void	ResetObject ()
	Resets this object. More...

Public Attributes
OnContainsCompleted	OnContainsCompleted
OnGetAllCompleted	OnGetAllCompleted
OnReplaceAllCompleted	OnReplaceAllCompleted
Public Attributes inherited from Crosstales.BWF.Manager.BaseManager< CapitalizationManager, CapitalizationFilter >
bool	isReady
	Checks the readiness status of the manager. More...

Protected Member Functions
override void	Awake ()
override void	OnApplicationQuit ()
Protected Member Functions inherited from Crosstales.BWF.Manager.BaseManager< CapitalizationManager, CapitalizationFilter >
void	onContainsComplete (string text, bool result)
void	onGetAllComplete (string text, System.Collections.Generic.List< string > badWords)
void	onReplaceAllComplete (string originalText, string cleanText)

Protected Attributes
override OnContainsCompleted	onContainsCompleted => OnContainsCompleted
override OnGetAllCompleted	onGetAllCompleted => OnGetAllCompleted
override OnReplaceAllCompleted	onReplaceAllCompleted => OnReplaceAllCompleted
Protected Attributes inherited from Crosstales.BWF.Manager.BaseManager< CapitalizationManager, CapitalizationFilter >
T	_filter

Properties
int????	CapitalizationCharsNumber [get, set]
	Defines the number of allowed capital letters in a row.. More...
Properties inherited from Crosstales.BWF.Manager.BaseManager< CapitalizationManager, CapitalizationFilter >
bool	DisableOrdering [get, set]
abstract OnContainsCompleted	onContainsCompleted [get]
abstract OnGetAllCompleted	onGetAllCompleted [get]
abstract OnReplaceAllCompleted	onReplaceAllCompleted [get]

Additional Inherited Members
Events inherited from Crosstales.BWF.Manager.BaseManager< CapitalizationManager, CapitalizationFilter >
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...

Detailed Description

Manager for excessive capitalization.

Member Function Documentation

Contains()

bool Crosstales.BWF.Manager.CapitalizationManager.Contains

(

string

text

)

Searches for excessive capitalizations in a text.

Parameters

text	Text to check

Returns

True if a match was found

ContainsAsync()

void Crosstales.BWF.Manager.CapitalizationManager.ContainsAsync

(

string

text

)

Searches asynchronously for excessive capitalizations in a text. Use the "OnContainsComplete"-callback to get the result.

Parameters

text	Text to check

GetAll()

System.Collections.Generic.List<string> Crosstales.BWF.Manager.CapitalizationManager.GetAll

(

string

text

)

Searches for excessive capitalizations in a text.

Parameters

text	Text to check

Returns

List with all the matches

GetAllAsync()

void Crosstales.BWF.Manager.CapitalizationManager.GetAllAsync

(

string

text

)

Searches asynchronously for excessive capitalizations in a text. Use the "OnGetAllComplete"-callback to get the result.

Parameters

text	Text to check

Load()

void Crosstales.BWF.Manager.CapitalizationManager.Load

(

)

Loads the current filter with all settings from this object.

Mark()

string Crosstales.BWF.Manager.CapitalizationManager.Mark	(	string	text,
		bool	replace = false,
		string	prefix = "<b><color=red>",
		string	postfix = "</color></b>"
	)

Marks the text with a prefix and postfix.

Parameters

text	Text containing excessive capitalizations
replace	Replace the excessive capitalizations (default: false, optional)
prefix	Prefix for every found capitalizations (default: bold and red, optional)
postfix	Postfix for every found capitalizations (default: bold and red, optional)

Returns

Text with marked excessive capitalizations

ReplaceAll()

string Crosstales.BWF.Manager.CapitalizationManager.ReplaceAll	(	string	text,
		bool	markOnly = false,
		string	prefix = "",
		string	postfix = ""
	)

Searches and replaces all excessive capitalizations in a text.

Parameters

text	Text to check
markOnly	Only mark the words (default: false, optional)
prefix	Prefix for every found capitalization (optional)
postfix	Postfix for every found capitalization (optional)

Returns

Clean text

ReplaceAllAsync()

void Crosstales.BWF.Manager.CapitalizationManager.ReplaceAllAsync	(	string	text,
		bool	markOnly = false,
		string	prefix = "",
		string	postfix = ""
	)

Searches and replaces asynchronously all domains in a text. Use the "OnReplaceAllComplete"-callback to get the result.

Parameters

text	Text to check
markOnly	Only mark the words (default: false, optional)
prefix	Prefix for every found capitalization (optional)
postfix	Postfix for every found capitalization (optional)

ResetObject()

static void Crosstales.BWF.Manager.CapitalizationManager.ResetObject ( )

static

Resets this object.

Property Documentation

CapitalizationCharsNumber

int???? Crosstales.BWF.Manager.CapitalizationManager.CapitalizationCharsNumber

getset

Defines the number of allowed capital letters in a row..

---

The documentation for this class was generated from the following file:

• C:/Users/slaub/Unity/assets/BWFPro/BWFPro/Assets/Plugins/crosstales/BadWordFilter/Scripts/Manager/CapitalizationManager.cs