Crosstales.BWF.Provider.BaseProvider Class Referenceabstract

Base class for all providers. More...

Inheritance diagram for Crosstales.BWF.Provider.BaseProvider:
Crosstales.BWF.Provider.IProvider Crosstales.BWF.Provider.BadWordProvider Crosstales.BWF.Provider.DomainProvider Crosstales.BWF.Provider.BadWordProviderText Crosstales.BWF.Provider.DomainProviderText

Public Member Functions

abstract void Load ()
 Loads all sources. More...
 
abstract void Save ()
 Saves all sources. More...
 
System.Collections.Generic.List< string > Verify (Crosstales.BWF.Data.Source source)
 Verify a source. More...
 

Public Attributes

System.Text.RegularExpressions.RegexOptions RegexOption1 = System.Text.RegularExpressions.RegexOptions.IgnoreCase
 Option1 (default: RegexOptions.IgnoreCase). More...
 
System.Text.RegularExpressions.RegexOptions RegexOption2 = System.Text.RegularExpressions.RegexOptions.CultureInvariant
 Option2 (default: RegexOptions.CultureInvariant). More...
 
System.Text.RegularExpressions.RegexOptions RegexOption3 = System.Text.RegularExpressions.RegexOptions.None
 Option3 (default: RegexOptions.None). More...
 
System.Text.RegularExpressions.RegexOptions RegexOption4 = System.Text.RegularExpressions.RegexOptions.None
 Option4 (default: RegexOptions.None). More...
 
System.Text.RegularExpressions.RegexOptions RegexOption5 = System.Text.RegularExpressions.RegexOptions.None
 Option5 (default: RegexOptions.None). More...
 
System.Collections.Generic.List< Crosstales.BWF.Data.SourceSources
 All sources for this provider. More...
 
bool ClearOnLoad = true
 Clears all existing bad words on 'Load' (default: true). More...
 

Protected Member Functions

abstract void init ()
 Initialize the provider. More...
 
void logNoResourcesAdded ()
 
void createSource ()
 

Protected Attributes

readonly System.Collections.Generic.List< string > coRoutines = new System.Collections.Generic.List<string>()
 
bool _loading = false
 

Properties

int???? RegexCount [get]
 Number of Regex of this provider. More...
 
bool isReady [get, set]
 
- Properties inherited from Crosstales.BWF.Provider.IProvider
bool isReady [get, set]
 Checks the readiness status of the provider. More...
 

Detailed Description

Base class for all providers.

Member Function Documentation

◆ init()

abstract void Crosstales.BWF.Provider.BaseProvider.init ( )
protectedpure virtual

◆ Load()

abstract void Crosstales.BWF.Provider.BaseProvider.Load ( )
pure virtual

◆ Save()

abstract void Crosstales.BWF.Provider.BaseProvider.Save ( )
pure virtual

◆ Verify()

System.Collections.Generic.List<string> Crosstales.BWF.Provider.BaseProvider.Verify ( Crosstales.BWF.Data.Source  source)

Verify a source.

Returns
An empty list if no errors are found, otherwise all the failed regexes.

Implements Crosstales.BWF.Provider.IProvider.

Member Data Documentation

◆ ClearOnLoad

bool Crosstales.BWF.Provider.BaseProvider.ClearOnLoad = true

Clears all existing bad words on 'Load' (default: true).

◆ RegexOption1

System.Text.RegularExpressions.RegexOptions Crosstales.BWF.Provider.BaseProvider.RegexOption1 = System.Text.RegularExpressions.RegexOptions.IgnoreCase

Option1 (default: RegexOptions.IgnoreCase).

◆ RegexOption2

System.Text.RegularExpressions.RegexOptions Crosstales.BWF.Provider.BaseProvider.RegexOption2 = System.Text.RegularExpressions.RegexOptions.CultureInvariant

Option2 (default: RegexOptions.CultureInvariant).

◆ RegexOption3

System.Text.RegularExpressions.RegexOptions Crosstales.BWF.Provider.BaseProvider.RegexOption3 = System.Text.RegularExpressions.RegexOptions.None

Option3 (default: RegexOptions.None).

◆ RegexOption4

System.Text.RegularExpressions.RegexOptions Crosstales.BWF.Provider.BaseProvider.RegexOption4 = System.Text.RegularExpressions.RegexOptions.None

Option4 (default: RegexOptions.None).

◆ RegexOption5

System.Text.RegularExpressions.RegexOptions Crosstales.BWF.Provider.BaseProvider.RegexOption5 = System.Text.RegularExpressions.RegexOptions.None

Option5 (default: RegexOptions.None).

◆ Sources

System.Collections.Generic.List<Crosstales.BWF.Data.Source> Crosstales.BWF.Provider.BaseProvider.Sources

All sources for this provider.

Property Documentation

◆ RegexCount

int???? Crosstales.BWF.Provider.BaseProvider.RegexCount
get

Number of Regex of this provider.

Returns
Number of Regex of this provider.

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