Eamon CS  3.1.0
Eamon.Framework.Helpers.Generic.IHelper< T > Interface Template Reference

More...

Inheritance diagram for Eamon.Framework.Helpers.Generic.IHelper< T >:
Eamon.Game.Helpers.Generic.Helper< T >

Public Member Functions

string GetFieldName (string name)
 
string GetFieldName (long listNum)
 
IList< string > GetNameList (Func< string, bool > matchFunc=null)
 
string GetPrintedName (string fieldName)
 
string GetName (string fieldName, bool addToNameList=false)
 
object GetValue (string fieldName)
 
bool ValidateRecord ()
 
bool ValidateField (string fieldName)
 
bool ValidateRecordAfterDatabaseLoaded ()
 
bool ValidateFieldAfterDatabaseLoaded (string fieldName)
 
bool ValidateRecordInterdependencies ()
 
bool ValidateFieldInterdependencies (string fieldName)
 
void PrintFieldDesc (string fieldName, bool editRec, bool editField, FieldDesc fieldDesc)
 
void PrintFieldDesc (string fieldName)
 
void ListRecord (bool fullDetail, bool showDesc, bool resolveEffects, bool lookupMsg, bool numberFields, bool excludeROFields)
 
void ListRecord (bool callClear=true)
 
void ListField (string fieldName)
 
void ListErrorField ()
 
void InputRecord (bool editRec, FieldDesc fieldDesc)
 
void InputRecord (bool callClear=true)
 
void InputField (string fieldName)
 
void Clear ()
 

Properties

IDbTable< T > RecordTable [get, set]
 
Record [get, set]
 
long Index [get, set]
 
StringBuilder Buf [get, set]
 
StringBuilder Buf01 [get, set]
 
bool EditRec [get, set]
 
bool EditField [get, set]
 
bool ShowDesc [get, set]
 
FieldDesc FieldDesc [get, set]
 
long BufSize [get, set]
 
char FillChar [get, set]
 
long Offset [get, set]
 
string ErrorFieldName [get, set]
 
string ErrorMessage [get, set]
 
Type RecordType [get, set]
 
IGameBase EditRecord [get, set]
 
long NewRecordUid [get, set]
 
bool FullDetail [get, set]
 
bool ResolveEffects [get, set]
 
bool LookupMsg [get, set]
 
bool NumberFields [get, set]
 
bool ExcludeROFields [get, set]
 
bool AddToListedNames [get, set]
 
long ListNum [get, set]
 

Detailed Description

Type Constraints
T :class 
T :IGameBase 

Member Function Documentation

◆ Clear()

◆ GetFieldName() [1/2]

string Eamon.Framework.Helpers.Generic.IHelper< T >.GetFieldName ( long  listNum)

Parameters
listNum
Returns

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ GetFieldName() [2/2]

string Eamon.Framework.Helpers.Generic.IHelper< T >.GetFieldName ( string  name)

Parameters
name
Returns

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ GetName()

string Eamon.Framework.Helpers.Generic.IHelper< T >.GetName ( string  fieldName,
bool  addToNameList = false 
)

Parameters
fieldName
addToNameList
Returns

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ GetNameList()

IList<string> Eamon.Framework.Helpers.Generic.IHelper< T >.GetNameList ( Func< string, bool >  matchFunc = null)

Parameters
matchFunc
Returns

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ GetPrintedName()

string Eamon.Framework.Helpers.Generic.IHelper< T >.GetPrintedName ( string  fieldName)

Parameters
fieldName
Returns

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ GetValue()

object Eamon.Framework.Helpers.Generic.IHelper< T >.GetValue ( string  fieldName)

Parameters
fieldName
Returns

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ InputField()

void Eamon.Framework.Helpers.Generic.IHelper< T >.InputField ( string  fieldName)

Parameters
fieldName

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ InputRecord() [1/2]

void Eamon.Framework.Helpers.Generic.IHelper< T >.InputRecord ( bool  callClear = true)

Parameters
callClear

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ InputRecord() [2/2]

void Eamon.Framework.Helpers.Generic.IHelper< T >.InputRecord ( bool  editRec,
FieldDesc  fieldDesc 
)

Parameters
editRec
fieldDesc

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ ListErrorField()

◆ ListField()

void Eamon.Framework.Helpers.Generic.IHelper< T >.ListField ( string  fieldName)

Parameters
fieldName

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ ListRecord() [1/2]

void Eamon.Framework.Helpers.Generic.IHelper< T >.ListRecord ( bool  callClear = true)

Parameters
callClear

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ ListRecord() [2/2]

void Eamon.Framework.Helpers.Generic.IHelper< T >.ListRecord ( bool  fullDetail,
bool  showDesc,
bool  resolveEffects,
bool  lookupMsg,
bool  numberFields,
bool  excludeROFields 
)

Parameters
fullDetail
showDesc
resolveEffects
lookupMsg
numberFields
excludeROFields

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ PrintFieldDesc() [1/2]

void Eamon.Framework.Helpers.Generic.IHelper< T >.PrintFieldDesc ( string  fieldName)

Parameters
fieldName

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ PrintFieldDesc() [2/2]

void Eamon.Framework.Helpers.Generic.IHelper< T >.PrintFieldDesc ( string  fieldName,
bool  editRec,
bool  editField,
FieldDesc  fieldDesc 
)

Parameters
fieldName
editRec
editField
fieldDesc

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ ValidateField()

bool Eamon.Framework.Helpers.Generic.IHelper< T >.ValidateField ( string  fieldName)

Parameters
fieldName
Returns

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ ValidateFieldAfterDatabaseLoaded()

bool Eamon.Framework.Helpers.Generic.IHelper< T >.ValidateFieldAfterDatabaseLoaded ( string  fieldName)

Parameters
fieldName
Returns

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ ValidateFieldInterdependencies()

bool Eamon.Framework.Helpers.Generic.IHelper< T >.ValidateFieldInterdependencies ( string  fieldName)

Parameters
fieldName
Returns

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ ValidateRecord()

bool Eamon.Framework.Helpers.Generic.IHelper< T >.ValidateRecord ( )

Returns

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ ValidateRecordAfterDatabaseLoaded()

bool Eamon.Framework.Helpers.Generic.IHelper< T >.ValidateRecordAfterDatabaseLoaded ( )

Returns

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

◆ ValidateRecordInterdependencies()

bool Eamon.Framework.Helpers.Generic.IHelper< T >.ValidateRecordInterdependencies ( )

Returns

Implemented in Eamon.Game.Helpers.Generic.Helper< T >.

Property Documentation

◆ AddToListedNames

bool Eamon.Framework.Helpers.Generic.IHelper< T >.AddToListedNames
getset

◆ Buf

StringBuilder Eamon.Framework.Helpers.Generic.IHelper< T >.Buf
getset

◆ Buf01

StringBuilder Eamon.Framework.Helpers.Generic.IHelper< T >.Buf01
getset

◆ BufSize

long Eamon.Framework.Helpers.Generic.IHelper< T >.BufSize
getset

◆ EditField

bool Eamon.Framework.Helpers.Generic.IHelper< T >.EditField
getset

◆ EditRec

bool Eamon.Framework.Helpers.Generic.IHelper< T >.EditRec
getset

◆ EditRecord

◆ ErrorFieldName

string Eamon.Framework.Helpers.Generic.IHelper< T >.ErrorFieldName
getset

◆ ErrorMessage

string Eamon.Framework.Helpers.Generic.IHelper< T >.ErrorMessage
getset

◆ ExcludeROFields

bool Eamon.Framework.Helpers.Generic.IHelper< T >.ExcludeROFields
getset

◆ FieldDesc

◆ FillChar

char Eamon.Framework.Helpers.Generic.IHelper< T >.FillChar
getset

◆ FullDetail

bool Eamon.Framework.Helpers.Generic.IHelper< T >.FullDetail
getset

◆ Index

◆ ListNum

long Eamon.Framework.Helpers.Generic.IHelper< T >.ListNum
getset

◆ LookupMsg

bool Eamon.Framework.Helpers.Generic.IHelper< T >.LookupMsg
getset

◆ NewRecordUid

long Eamon.Framework.Helpers.Generic.IHelper< T >.NewRecordUid
getset

◆ NumberFields

bool Eamon.Framework.Helpers.Generic.IHelper< T >.NumberFields
getset

◆ Offset

long Eamon.Framework.Helpers.Generic.IHelper< T >.Offset
getset

◆ Record

◆ RecordTable

◆ RecordType

Type Eamon.Framework.Helpers.Generic.IHelper< T >.RecordType
getset

◆ ResolveEffects

bool Eamon.Framework.Helpers.Generic.IHelper< T >.ResolveEffects
getset

◆ ShowDesc

bool Eamon.Framework.Helpers.Generic.IHelper< T >.ShowDesc
getset


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