Elin Modding Docs Doc
Loading...
Searching...
No Matches
Card Class Reference
Inheritance diagram for Card:
BaseCard IReservable ICardParent IRenderSource IGlobalValue IInspect EClass Chara Thing

Public Types

enum  MoveResult { Fail , Success , Door }
 
enum  MoveType { Walk , Force }
 
- Public Types inherited from IInspect
enum  NoteMode { Default , Recipe , Product , Info }
 

Public Member Functions

override string ToString ()
 
bool CanReserve (AIAct act)
 
bool TryReserve (AIAct act)
 
void Mod ()
 
Window.SaveData GetWindowSaveData ()
 
bool IsExcludeFromCraft ()
 
void SetDirtyWeight ()
 
void ChangeWeight (int a)
 
int Evalue (int ele)
 
int Evalue (string alias)
 
bool HasTag (CTAG tag)
 
bool HasEditorTag (EditorTag tag)
 
void AddEditorTag (EditorTag tag)
 
void RemoveEditorTag (EditorTag tag)
 
virtual string GetName (NameStyle style, int num=-1)
 
virtual string GetExtraName ()
 
virtual string GetDetail ()
 
int GetBestAttribute ()
 
void ModExp (string alias, int a)
 
void ModExp (int ele, int a)
 
bool IsChildOf (Card c)
 
string ReferenceId ()
 
void Create (string _id, int _idMat=-1, int genLv=-1)
 
virtual void OnBeforeCreate ()
 
virtual void OnCreate (int genLv)
 
virtual void SetSource ()
 
virtual void ApplyEditorTags (EditorTag tag)
 
void ApplyTrait ()
 
Card SetLv (int a)
 
void AddExp (int a)
 
void LevelUp ()
 
virtual void ApplyMaterialElements (bool remove)
 
virtual void ApplyMaterial (bool remove=false)
 
Card ChangeMaterial (int idNew)
 
Card ChangeMaterial (string idNew)
 
Card ChangeMaterial (SourceMaterial.Row row)
 
void SetReplica (bool on)
 
Thing Add (string id, int num=1, int lv=1)
 
Card AddCard (Card c)
 
void RemoveCard (Card c)
 
void NotifyAddThing (Thing t, int num)
 
Thing AddThing (string id, int lv=-1)
 
Thing AddThing (Thing t, bool tryStack=true, int destInvX=-1, int destInvY=-1)
 
void RemoveThings ()
 
void RemoveThing (Thing thing)
 
bool ShouldTrySetDirtyInventory ()
 
virtual bool CanStackTo (Thing to)
 
bool TryStackTo (Thing to)
 
ICardParent GetRoot ()
 
Card GetRootCard ()
 
bool IsStackable (Thing tg)
 
Thing Duplicate (int num)
 
Thing Split (int a)
 
Thing SetNum (int a)
 
Thing SetNoSell ()
 
void ModNum (int a, bool notify=true)
 
void AddSocket ()
 
void ApplySocket (Thing t)
 
void ApplySocket (int id, int lv, Card mod=null)
 
void EjectSockets ()
 
void OnChildNumChange (Card c)
 
Card Install ()
 
void SetPlaceState (PlaceState newState, bool byPlayer=false)
 
int GetTotalQuality (bool applyBonus=true)
 
void ModEncLv (int a)
 
void SetEncLv (int a)
 
virtual void SetBlessedState (BlessedState s)
 
virtual void ChangeRarity (Rarity q)
 
bool TryPay (int a, string id="money")
 
void SetCharge (int a)
 
void ModCharge (int a, bool destroy=false)
 
void ModCurrency (int a, string id="money")
 
int GetCurrency (string id="money")
 
virtual void HealHPHost (int a, HealSource origin=HealSource.None)
 
virtual void HealHP (int a, HealSource origin=HealSource.None)
 
virtual int GetArmorSkill ()
 
virtual int ApplyProtection (int dmg, int mod=100)
 
void DamageHP (int dmg, AttackSource attackSource=AttackSource.None, Card origin=null)
 
void DamageHP (int dmg, int ele, int eleP=100, AttackSource attackSource=AttackSource.None, Card origin=null, bool showEffect=true)
 
virtual void Die (Element e=null, Card origin=null, AttackSource attackSource=AttackSource.None)
 
void Explode (Point p, Card origin)
 
void Deconstruct ()
 
void Destroy ()
 
void SpawnLoot (Card origin)
 
Thing TryMakeRandomItem (int lv=-1)
 
Card MakeFoodFrom (string _id)
 
Card MakeFoodFrom (Card c)
 
void MakeFoodRef (Card c1, Card c2=null)
 
string TryGetFoodName (Card c)
 
string GetFoodName (string s)
 
void MakeFigureFrom (string id)
 
void MakeRefFrom (string id)
 
void MakeRefFrom (Card c1, Card c2=null)
 
void SetHidden (bool hide=true)
 
virtual Card.MoveResult _Move (Point p, Card.MoveType type=Card.MoveType.Walk)
 
unsafe void MoveImmediate (Point p, bool focus=true, bool cancelAI=true)
 
unsafe void Teleport (Point point, bool silent=false, bool force=false)
 
virtual void OnLand ()
 
int ResistLvFrom (int ele)
 
int ResistLv (int res)
 
bool HasElement (int ele, int req=1)
 
bool HasElement (string id, int req=1)
 
virtual CardRenderer _CreateRenderer ()
 
void AddBlood (int a=1, int id=-1)
 
RenderParam GetRenderParam ()
 
virtual void SetRenderParam (RenderParam p)
 
void DyeRandom ()
 
void Dye (string idMat)
 
void Dye (SourceMaterial.Row mat)
 
void RefreshColor ()
 
ref Color GetRandomColor ()
 
virtual Sprite GetSprite (int dir=0)
 
virtual Sprite GetImageSprite ()
 
void SetImage (Image image, int dir, int idSkin=0)
 
virtual void SetImage (Image image)
 
void ShowEmo (Emo _emo=Emo.none, float duration=0f, bool skipSame=true)
 
void PlaySoundHold (bool spatial=true)
 
void PlaySoundDrop (bool spatial=true)
 
SoundSource PlaySound (string id, float v=1f, bool spatial=true)
 
void KillAnime ()
 
void PlayAnime (AnimeID id, bool force=false)
 
void PlayAnime (AnimeID id, Point dest, bool force=false)
 
void PlayAnimeLoot ()
 
unsafe Effect PlayEffect (string id, bool useRenderPos=true, float range=0f, Vector3 fix=default(Vector3))
 
unsafe void PlayEffect (int ele, bool useRenderPos=true, float range=0f)
 
virtual void SetDir (int d)
 
void SetRandomDir ()
 
virtual void LookAt (Card c)
 
virtual void LookAt (Point p)
 
virtual void Rotate (bool reverse=false)
 
void ChangeAltitude (int a)
 
virtual SubPassData GetSubPassData ()
 
unsafe void SetFreePos (Point point)
 
unsafe void RenderMarker (Point point, bool active, HitResult result, bool main, int dir, bool useCurrentPosition=false)
 
void RecalculateFOV ()
 
bool HasLight ()
 
float GetLightPower ()
 
int GetSightRadius ()
 
int GetLightRadius ()
 
void CalculateFOV ()
 
void SetRandomLightColors ()
 
Fov CreateFov ()
 
void ClearFOV ()
 
virtual void OnSimulateHour (VirtualDate date)
 
void DecayNatural (int hour=1)
 
void Decay (int a=10)
 
void Talk (string idTopic, string ref1=null, string ref2=null, bool forceSync=false)
 
void TalkRaw (string text, string ref1=null, string ref2=null, bool forceSync=false)
 
string ApplyNewLine (string text)
 
void SayRaw (string text, string ref1=null, string ref2=null)
 
void SayNothingHappans ()
 
void Say (string lang, string ref1=null, string ref2=null)
 
void Say (string lang, Card c1, Card c2, string ref1=null, string ref2=null)
 
void Say (string lang, Card c1, string ref1=null, string ref2=null)
 
string GetTalkText (string idTopic, bool stripPun=false, bool useDefault=true)
 
string ApplyTone (string text, bool stripPun=false)
 
void SetRandomTalk ()
 
void SetRandomTone ()
 
void TryStack (Thing t)
 
void ApplyBacker (int bid)
 
void RemoveBacker ()
 
void SetPaintData ()
 
byte[] GetPaintData ()
 
void ClearPaintSprite ()
 
Sprite GetPaintSprite ()
 
void TryUnrestrain (bool force=false, Chara c=null)
 
TraitShackle GetRestrainer ()
 
virtual void Tick ()
 
Thing SetPriceFix (int a)
 
int GetEquipValue ()
 
void SetSale (bool sale)
 
int GetValue (bool sell=false)
 
virtual int GetPrice (CurrencyType currency=CurrencyType.Money, bool sell=false, PriceType priceType=PriceType.Default, Chara c=null)
 
virtual string GetHoverText ()
 
virtual string GetHoverText2 ()
 
int Dist (Card c)
 
int Dist (Point p)
 
bool IsInMutterDistance (int d=10)
 
void SetCensored (bool enable)
 
void SetDeconstruct (bool deconstruct)
 
virtual void SetSortVal (UIList.SortMode m, CurrencyType currency=CurrencyType.Money)
 
virtual int SecondaryCompare (UIList.SortMode m, Card c)
 
void ForeachFOV (Func< Point, bool > func)
 
void ForeachPoint (Action< Point, bool > action)
 
void OnInspect ()
 
virtual void WriteNote (UINote n, Action< UINote > onWriteNote=null, IInspect.NoteMode mode=IInspect.NoteMode.Default, Recipe recipe=null)
 
void Inspect ()
 
virtual bool HasCondition< T > ()
 
bool HaveFur ()
 
bool CanBeSheared ()
 
- Public Member Functions inherited from BaseCard
bool GetBool (int id)
 
void SetBool (int id, bool enable)
 
int GetInt (int id, int? defaultInt=null)
 
void AddInt (int id, int value)
 
void SetInt (int id, int value=0)
 
string GetStr (int id, string defaultStr=null)
 
void SetStr (int id, string value=null)
 
GetObj< T > (int id)
 
void SetObj (int id, object o)
 
SetObj< T > (int id, object o)
 
- Public Member Functions inherited from ICardParent
- Public Member Functions inherited from IGlobalValue
- Public Member Functions inherited from IInspect

Static Public Member Functions

static string ApplyTone (Chara c, ref string text, string _tones, int gender, bool stripPun=false)
 
static int GetTilePrice (TileRow row, SourceMaterial.Row mat)
 
- Static Public Member Functions inherited from EClass
static int rnd (int a)
 
static int curve (int a, int start, int step, int rate=75)
 
static int rndHalf (int a)
 
static float rndf (float a)
 
static int rndSqrt (int a)
 
static void Wait (float a, Card c)
 
static void Wait (float a, Point p)
 
static int Bigger (int a, int b)
 
static int Smaller (int a, int b)
 

Public Attributes

int[] _ints = new int[30]
 
string id = ""
 
ThingContainer things = new ThingContainer()
 
ElementContainerCard elements = new ElementContainerCard()
 
Biography bio
 
List< int > sockets
 
AIAct reservedAct
 
Props props
 
Trait trait
 
ICardParent parent
 
Fov fov
 
Point pos = new Point()
 
CardRenderer renderer
 
int turn
 
int _colorInt
 
float roundTimer
 
float angle = 180f
 
bool isDestroyed
 
CardBlueprint bp
 
BitArray32 _bits1
 
BitArray32 _bits2
 
PlaceState placeState
 
bool dirtyWeight = true
 
SourceMaterial.Row _material
 
Emo lastEmo
 
int sortVal
 
- Public Attributes inherited from BaseCard
Dictionary< int, object > mapObj = new Dictionary<int, object>()
 
Dictionary< int, int > mapInt = new Dictionary<int, int>()
 
Dictionary< int, string > mapStr = new Dictionary<int, string>()
 

Protected Member Functions

virtual void OnSerializing ()
 
virtual void OnDeserialized ()
 

Properties

Card parentCard [get]
 
Thing parentThing [get]
 
int colorInt [get]
 
bool IsHotItem [get]
 
int uid [get, set]
 
int idMaterial [get, set]
 
int dir [get, set]
 
int Num [get, set]
 
int _x [get, set]
 
int _z [get, set]
 
int refVal [get, set]
 
int decay [get, set]
 
int altitude [get, set]
 
int hp [get, set]
 
float fx [get, set]
 
float fy [get, set]
 
BlessedState blessedState [get, set]
 
PlaceState _placeState [get, set]
 
int rarityLv [get, set]
 
Rarity rarity [get, set]
 
int encLV [get, set]
 
int posInvX [get, set]
 
int posInvY [get, set]
 
int idSkin [get, set]
 
int feat [get, set]
 
int LV [get, set]
 
int exp [get, set]
 
int qualityTier [get, set]
 
bool isCensored [get, set]
 
bool isDeconstructing [get, set]
 
bool isDyed [get, set]
 
bool isModified [get, set]
 
bool isNew [get, set]
 
bool isPlayerCreation [get, set]
 
bool ignoreAutoPick [get, set]
 
bool freePos [get, set]
 
bool isHidden [get, set]
 
bool isOn [get, set]
 
bool isNPCProperty [get, set]
 
bool isRestrained [get, set]
 
bool isRoofItem [get, set]
 
bool isMasked [get, set]
 
bool disableAutoToggle [get, set]
 
bool isImported [get, set]
 
bool autoRefuel [get, set]
 
bool ignoreStackHeight [get, set]
 
bool isFloating [get, set]
 
bool isWeightChanged [get, set]
 
bool isFireproof [get, set]
 
bool isAcidproof [get, set]
 
bool isReplica [get, set]
 
bool isSummon [get, set]
 
bool isElemental [get, set]
 
bool isBroken [get, set]
 
bool isSubsetCard [get, set]
 
bool noSnow [get, set]
 
bool noMove [get, set]
 
bool isGifted [get, set]
 
bool isCrafted [get, set]
 
bool isLostProperty [get, set]
 
bool noShadow [get, set]
 
bool noSell [get, set]
 
bool isLeashed [get, set]
 
bool isStolen [get, set]
 
bool isSale [get, set]
 
bool isCopy [get, set]
 
bool isRestocking [get, set]
 
bool isBackerContent [get]
 
SourceBacker.Row sourceBacker [get]
 
BedType c_bedType [get, set]
 
int c_equippedSlot [get, set]
 
int c_lockLv [get, set]
 
Hostility c_originalHostility [get, set]
 
MinionType c_minionType [get, set]
 
int c_vomit [get, set]
 
bool c_isImportant [get, set]
 
bool c_lockedHard [get, set]
 
bool c_revealLock [get, set]
 
bool c_isTrained [get, set]
 
bool c_isPrayed [get, set]
 
int c_lightColor [get, set]
 
Color LightColor [get]
 
int c_uidZone [get, set]
 
int c_uidRefCard [get, set]
 
int c_priceFix [get, set]
 
int c_priceAdd [get, set]
 
int c_dyeMat [get, set]
 
VisitorState visitorState [get, set]
 
RescueState c_rescueState [get, set]
 
BossType c_bossType [get, set]
 
int c_dateStockExpire [get, set]
 
int c_IDTState [get, set]
 
int c_charges [get, set]
 
int c_bill [get, set]
 
int c_invest [get, set]
 
int c_seed [get, set]
 
int c_allowance [get, set]
 
int c_fur [get, set]
 
int c_containerSize [get, set]
 
int c_weight [get, set]
 
int c_diceDim [get, set]
 
int c_indexContainerIcon [get, set]
 
int c_idMainElement [get, set]
 
int c_summonDuration [get, set]
 
int c_idBacker [get, set]
 
int c_uidMaster [get, set]
 
int c_ammo [get, set]
 
int c_daysWithGod [get, set]
 
string c_idPortrait [get, set]
 
string c_idRace [get, set]
 
string c_idJob [get, set]
 
string c_idTone [get, set]
 
string c_color [get, set]
 
string c_idTalk [get, set]
 
string c_idDeity [get, set]
 
string c_altName [get, set]
 
string c_altName2 [get, set]
 
string c_refText [get, set]
 
string c_idRefName [get, set]
 
string c_idRidePCC [get, set]
 
string c_idAbility [get, set]
 
string c_context [get, set]
 
string c_idEditor [get, set]
 
string c_editorTags [get, set]
 
string c_editorTraitVal [get, set]
 
string c_idTrait [get, set]
 
string c_idRefCard [get, set]
 
string c_idRefCard2 [get, set]
 
string c_note [get, set]
 
UniqueData c_uniqueData [get, set]
 
Thing ammoData [get, set]
 
Thing c_copyContainer [get, set]
 
Window.SaveData c_windowSaveData [get, set]
 
CharaUpgrade c_upgrades [get, set]
 
CharaGenes c_genes [get, set]
 
ContainerUpgrade c_containerUpgrade [get, set]
 
DNA c_DNA [get, set]
 
CharaList c_charaList [get, set]
 
byte[] c_textureData [get, set]
 
SourceMaterial.Row DyeMat [get]
 
int invX [get, set]
 
int invY [get, set]
 
CardRow refCard [get]
 
CardRow refCard2 [get]
 
int ExpToNext [get]
 
int DefaultLV [get]
 
int ChildrenWeight [get]
 
int ChildrenAndSelfWeight [get]
 
int ChildrenAndSelfWeightSingle [get]
 
virtual int SelfWeight [get]
 
virtual int WeightLimit [get]
 
SourceCategory.Row category [get]
 
SourceMaterial.Row material [get]
 
virtual string AliasMaterialOnCreate [get]
 
Cell Cell [get]
 
virtual Thing Thing [get]
 
virtual Chara Chara [get]
 
virtual bool isThing [get]
 
virtual bool isChara [get]
 
bool ExistsOnMap [get]
 
virtual bool isSynced [get]
 
bool IsContainer [get]
 
bool IsUnique [get]
 
bool IsPowerful [get]
 
bool IsImportant [get]
 
virtual SourcePref Pref [get]
 
virtual bool IsDeadOrSleeping [get]
 
virtual bool IsDisabled [get]
 
virtual bool IsMoving [get]
 
virtual bool flipX [get]
 
virtual bool IsAliveInCurrentZone [get]
 
virtual string actorPrefab [get]
 
virtual CardRow sourceCard [get]
 
virtual CardRow sourceRenderCard [get]
 
TileType TileType [get]
 
string Name [get]
 
string NameSimple [get]
 
virtual bool IsPC [get]
 
bool _IsPC [get]
 
virtual bool IsPCC [get]
 
virtual bool IsPCParty [get]
 
virtual bool IsMinion [get]
 
virtual bool IsPCPartyMinion [get]
 
virtual bool IsPCFactionMinion [get]
 
virtual bool IsMultisize [get]
 
bool IsToolbelt [get]
 
bool IsLightsource [get]
 
bool IsEquipment [get]
 
bool IsFood [get]
 
bool ShowFoodEnc [get]
 
bool IsWeapon [get]
 
bool IsEquipmentOrRanged [get]
 
bool IsMeleeWeapon [get]
 
bool IsRangedWeapon [get]
 
bool IsThrownWeapon [get]
 
bool IsAmmo [get]
 
bool IsAgent [get]
 
bool IsFurniture [get]
 
bool IsBlessed [get]
 
bool IsCursed [get]
 
bool IsRestrainedResident [get]
 
virtual bool IsPCFaction [get]
 
bool IsPCFactionOrMinion [get]
 
virtual bool IsGlobal [get]
 
virtual int MaxDecay [get]
 
bool IsDecayed [get]
 
bool IsRotting [get]
 
bool IsFresn [get]
 
virtual int MaxHP [get]
 
virtual int Power [get]
 
int FameLv [get]
 
virtual int[] Tiles [get]
 
virtual int PrefIndex [get]
 
bool IsVariation [get]
 
virtual int DV [get]
 
virtual int PV [get]
 
int HIT [get]
 
int DMG [get]
 
int STR [get]
 
int DEX [get]
 
int END [get]
 
int PER [get]
 
int LER [get]
 
int WIL [get]
 
int MAG [get]
 
int CHA [get]
 
int INT [get]
 
int LUC [get]
 
int W [get]
 
int H [get]
 
bool IsIdentified [get]
 
string TextRarity [get]
 
bool IsInstalled [get]
 
bool IsMale [get]
 
bool IsNegativeGift [get]
 
bool HasContainerSize [get]
 
Thing Tool [get]
 
virtual SourceMaterial.Row DefaultMaterial [get]
 
virtual bool HasHost [get]
 
int Quality [get]
 
int QualityLv [get]
 
Point ThisOrParentPos [get]
 
LightData LightData [get]
 
CardRenderer HostRenderer [get]
 
bool ShouldShowMsg [get]
 
bool CanInspect [get]
 
string InspectName [get]
 
Point InspectPoint [get]
 
Vector3 InspectPosition [get]
 
- Properties inherited from EClass
static Game game [get]
 
static bool AdvMode [get]
 
static Player player [get]
 
static Chara pc [get]
 
static UI ui [get]
 
static Map _map [get]
 
static Zone _zone [get]
 
static FactionBranch Branch [get]
 
static FactionBranch BranchOrHomeBranch [get]
 
static Faction Home [get]
 
static Faction Wilds [get]
 
static Scene scene [get]
 
static BaseGameScreen screen [get]
 
static GameSetting setting [get]
 
static GameData gamedata [get]
 
static ColorProfile Colors [get]
 
static World world [get]
 
static SourceManager sources [get]
 
static SourceManager editorSources [get]
 
static SoundManager Sound [get]
 
static CoreDebug debug [get]
 
- Properties inherited from IInspect

Additional Inherited Members

- Static Public Attributes inherited from EClass
static Core core
 

Detailed Description

Definition at line 12 of file Card.cs.

Member Enumeration Documentation

◆ MoveResult

enum Card.MoveResult

Definition at line 8031 of file Card.cs.

◆ MoveType

enum Card.MoveType

Definition at line 8042 of file Card.cs.

Member Function Documentation

◆ _CreateRenderer()

virtual CardRenderer Card._CreateRenderer ( )
virtual

Definition at line 5932 of file Card.cs.

◆ _Move()

virtual Card.MoveResult Card._Move ( Point p,
Card.MoveType type = Card::MoveType::Walk )
virtual

Definition at line 5817 of file Card.cs.

◆ Add()

Thing Card.Add ( string id,
int num = 1,
int lv = 1 )

Definition at line 3741 of file Card.cs.

◆ AddBlood()

void Card.AddBlood ( int a = 1,
int id = -1 )

Definition at line 5940 of file Card.cs.

◆ AddCard()

Card Card.AddCard ( Card c)

Definition at line 3751 of file Card.cs.

◆ AddEditorTag()

void Card.AddEditorTag ( EditorTag tag)

Definition at line 2413 of file Card.cs.

◆ AddExp()

void Card.AddExp ( int a)

Definition at line 3630 of file Card.cs.

◆ AddSocket()

void Card.AddSocket ( )

Definition at line 4097 of file Card.cs.

◆ AddThing() [1/2]

Thing Card.AddThing ( string id,
int lv = -1 )

Definition at line 3768 of file Card.cs.

◆ AddThing() [2/2]

Thing Card.AddThing ( Thing t,
bool tryStack = true,
int destInvX = -1,
int destInvY = -1 )

Definition at line 3774 of file Card.cs.

◆ ApplyBacker()

void Card.ApplyBacker ( int bid)

Definition at line 6962 of file Card.cs.

◆ ApplyEditorTags()

virtual void Card.ApplyEditorTags ( EditorTag tag)
virtual

Definition at line 3532 of file Card.cs.

◆ ApplyMaterial()

virtual void Card.ApplyMaterial ( bool remove = false)
virtual

Definition at line 3691 of file Card.cs.

◆ ApplyMaterialElements()

virtual void Card.ApplyMaterialElements ( bool remove)
virtual

Definition at line 3686 of file Card.cs.

◆ ApplyNewLine()

string Card.ApplyNewLine ( string text)

Definition at line 6735 of file Card.cs.

◆ ApplyProtection()

virtual int Card.ApplyProtection ( int dmg,
int mod = 100 )
virtual

Definition at line 4469 of file Card.cs.

◆ ApplySocket() [1/2]

void Card.ApplySocket ( int id,
int lv,
Card mod = null )

Definition at line 4118 of file Card.cs.

◆ ApplySocket() [2/2]

void Card.ApplySocket ( Thing t)

Definition at line 4107 of file Card.cs.

◆ ApplyTone() [1/2]

static string Card.ApplyTone ( Chara c,
ref string text,
string _tones,
int gender,
bool stripPun = false )
static

Definition at line 6860 of file Card.cs.

◆ ApplyTone() [2/2]

string Card.ApplyTone ( string text,
bool stripPun = false )

Definition at line 6850 of file Card.cs.

◆ ApplyTrait()

void Card.ApplyTrait ( )

Definition at line 3575 of file Card.cs.

◆ CalculateFOV()

void Card.CalculateFOV ( )

Definition at line 6473 of file Card.cs.

◆ CanBeSheared()

bool Card.CanBeSheared ( )

Definition at line 7875 of file Card.cs.

◆ CanReserve()

bool Card.CanReserve ( AIAct act)

Definition at line 31 of file Card.cs.

◆ CanStackTo()

virtual bool Card.CanStackTo ( Thing to)
virtual

Definition at line 3945 of file Card.cs.

◆ ChangeAltitude()

void Card.ChangeAltitude ( int a)

Definition at line 6235 of file Card.cs.

◆ ChangeMaterial() [1/3]

Card Card.ChangeMaterial ( int idNew)

Definition at line 3697 of file Card.cs.

◆ ChangeMaterial() [2/3]

Card Card.ChangeMaterial ( SourceMaterial.Row row)

Definition at line 3709 of file Card.cs.

◆ ChangeMaterial() [3/3]

Card Card.ChangeMaterial ( string idNew)

Definition at line 3703 of file Card.cs.

◆ ChangeRarity()

virtual void Card.ChangeRarity ( Rarity q)
virtual

Definition at line 4350 of file Card.cs.

◆ ChangeWeight()

void Card.ChangeWeight ( int a)

Definition at line 2300 of file Card.cs.

◆ ClearFOV()

void Card.ClearFOV ( )

Definition at line 6568 of file Card.cs.

◆ ClearPaintSprite()

void Card.ClearPaintSprite ( )

Definition at line 7045 of file Card.cs.

◆ Create()

void Card.Create ( string _id,
int _idMat = -1,
int genLv = -1 )

Definition at line 3417 of file Card.cs.

◆ CreateFov()

Fov Card.CreateFov ( )

Definition at line 6517 of file Card.cs.

◆ DamageHP() [1/2]

void Card.DamageHP ( int dmg,
AttackSource attackSource = AttackSource::None,
Card origin = null )

Definition at line 4495 of file Card.cs.

◆ DamageHP() [2/2]

void Card.DamageHP ( int dmg,
int ele,
int eleP = 100,
AttackSource attackSource = AttackSource::None,
Card origin = null,
bool showEffect = true )

Definition at line 4501 of file Card.cs.

◆ Decay()

void Card.Decay ( int a = 10)

Definition at line 6611 of file Card.cs.

◆ DecayNatural()

void Card.DecayNatural ( int hour = 1)

Definition at line 6588 of file Card.cs.

◆ Deconstruct()

void Card.Deconstruct ( )

Definition at line 5250 of file Card.cs.

◆ Destroy()

void Card.Destroy ( )

Definition at line 5257 of file Card.cs.

◆ Die()

virtual void Card.Die ( Element e = null,
Card origin = null,
AttackSource attackSource = AttackSource::None )
virtual

Definition at line 5186 of file Card.cs.

◆ Dist() [1/2]

int Card.Dist ( Card c)

Definition at line 7637 of file Card.cs.

◆ Dist() [2/2]

int Card.Dist ( Point p)

Definition at line 7660 of file Card.cs.

◆ Duplicate()

Thing Card.Duplicate ( int num)

Definition at line 3999 of file Card.cs.

◆ Dye() [1/2]

void Card.Dye ( SourceMaterial.Row mat)

Definition at line 5982 of file Card.cs.

◆ Dye() [2/2]

void Card.Dye ( string idMat)

Definition at line 5976 of file Card.cs.

◆ DyeRandom()

void Card.DyeRandom ( )

Definition at line 5970 of file Card.cs.

◆ EjectSockets()

void Card.EjectSockets ( )

Definition at line 4146 of file Card.cs.

◆ Evalue() [1/2]

int Card.Evalue ( int ele)

Definition at line 2388 of file Card.cs.

◆ Evalue() [2/2]

int Card.Evalue ( string alias)

Definition at line 2394 of file Card.cs.

◆ Explode()

void Card.Explode ( Point p,
Card origin )

Definition at line 5239 of file Card.cs.

◆ ForeachFOV()

void Card.ForeachFOV ( Func< Point, bool > func)

Definition at line 7766 of file Card.cs.

◆ ForeachPoint()

void Card.ForeachPoint ( Action< Point, bool > action)

Definition at line 7783 of file Card.cs.

◆ GetArmorSkill()

virtual int Card.GetArmorSkill ( )
virtual

Definition at line 4463 of file Card.cs.

◆ GetBestAttribute()

int Card.GetBestAttribute ( )

Definition at line 3199 of file Card.cs.

◆ GetCurrency()

int Card.GetCurrency ( string id = "money")

Definition at line 4411 of file Card.cs.

◆ GetDetail()

virtual string Card.GetDetail ( )
virtual

Definition at line 2675 of file Card.cs.

◆ GetEquipValue()

int Card.GetEquipValue ( )

Definition at line 7147 of file Card.cs.

◆ GetExtraName()

virtual string Card.GetExtraName ( )
virtual

Definition at line 2669 of file Card.cs.

◆ GetFoodName()

string Card.GetFoodName ( string s)

Definition at line 5780 of file Card.cs.

◆ GetHoverText()

virtual string Card.GetHoverText ( )
virtual

Definition at line 7625 of file Card.cs.

◆ GetHoverText2()

virtual string Card.GetHoverText2 ( )
virtual

Definition at line 7631 of file Card.cs.

◆ GetImageSprite()

virtual Sprite Card.GetImageSprite ( )
virtual

Definition at line 6051 of file Card.cs.

◆ GetLightPower()

float Card.GetLightPower ( )

Definition at line 6377 of file Card.cs.

◆ GetLightRadius()

int Card.GetLightRadius ( )

Definition at line 6402 of file Card.cs.

◆ GetName()

virtual string Card.GetName ( NameStyle style,
int num = -1 )
virtual

Definition at line 2663 of file Card.cs.

◆ GetPaintData()

byte[] Card.GetPaintData ( )

Definition at line 7026 of file Card.cs.

◆ GetPaintSprite()

Sprite Card.GetPaintSprite ( )

Definition at line 7056 of file Card.cs.

◆ GetPrice()

virtual int Card.GetPrice ( CurrencyType currency = CurrencyType::Money,
bool sell = false,
PriceType priceType = PriceType::Default,
Chara c = null )
virtual

Definition at line 7250 of file Card.cs.

◆ GetRandomColor()

ref Color Card.GetRandomColor ( )

Definition at line 6030 of file Card.cs.

◆ GetRenderParam()

RenderParam Card.GetRenderParam ( )

Definition at line 5954 of file Card.cs.

◆ GetRestrainer()

TraitShackle Card.GetRestrainer ( )

Definition at line 7106 of file Card.cs.

◆ GetRoot()

ICardParent Card.GetRoot ( )

Implements ICardParent.

Definition at line 3972 of file Card.cs.

◆ GetRootCard()

Card Card.GetRootCard ( )

Definition at line 3982 of file Card.cs.

◆ GetSightRadius()

int Card.GetSightRadius ( )

Definition at line 6392 of file Card.cs.

◆ GetSprite()

virtual Sprite Card.GetSprite ( int dir = 0)
virtual

Definition at line 6040 of file Card.cs.

◆ GetSubPassData()

virtual SubPassData Card.GetSubPassData ( )
virtual

Definition at line 6249 of file Card.cs.

◆ GetTalkText()

string Card.GetTalkText ( string idTopic,
bool stripPun = false,
bool useDefault = true )

Definition at line 6830 of file Card.cs.

◆ GetTilePrice()

static int Card.GetTilePrice ( TileRow row,
SourceMaterial.Row mat )
static

Definition at line 7124 of file Card.cs.

◆ GetTotalQuality()

int Card.GetTotalQuality ( bool applyBonus = true)

Definition at line 4290 of file Card.cs.

◆ GetValue()

int Card.GetValue ( bool sell = false)

Definition at line 7169 of file Card.cs.

◆ GetWindowSaveData()

Window.SaveData Card.GetWindowSaveData ( )

Definition at line 2105 of file Card.cs.

◆ HasCondition< T >()

virtual bool Card.HasCondition< T > ( )
virtual
Type Constraints
T :Condition 

Definition at line 7858 of file Card.cs.

◆ HasEditorTag()

bool Card.HasEditorTag ( EditorTag tag)

Definition at line 2406 of file Card.cs.

◆ HasElement() [1/2]

bool Card.HasElement ( int ele,
int req = 1 )

Definition at line 5920 of file Card.cs.

◆ HasElement() [2/2]

bool Card.HasElement ( string id,
int req = 1 )

Definition at line 5926 of file Card.cs.

◆ HasLight()

bool Card.HasLight ( )

Definition at line 6357 of file Card.cs.

◆ HasTag()

bool Card.HasTag ( CTAG tag)

Definition at line 2400 of file Card.cs.

◆ HaveFur()

bool Card.HaveFur ( )

Definition at line 7864 of file Card.cs.

◆ HealHP()

virtual void Card.HealHP ( int a,
HealSource origin = HealSource::None )
virtual

Definition at line 4441 of file Card.cs.

◆ HealHPHost()

virtual void Card.HealHPHost ( int a,
HealSource origin = HealSource::None )
virtual

Definition at line 4424 of file Card.cs.

◆ Inspect()

void Card.Inspect ( )

Definition at line 7844 of file Card.cs.

◆ Install()

Card Card.Install ( )

Definition at line 4179 of file Card.cs.

◆ IsChildOf()

bool Card.IsChildOf ( Card c)

Definition at line 3314 of file Card.cs.

◆ IsExcludeFromCraft()

bool Card.IsExcludeFromCraft ( )

Definition at line 2119 of file Card.cs.

◆ IsInMutterDistance()

bool Card.IsInMutterDistance ( int d = 10)

Definition at line 7666 of file Card.cs.

◆ IsStackable()

bool Card.IsStackable ( Thing tg)

Definition at line 3993 of file Card.cs.

◆ KillAnime()

void Card.KillAnime ( )

Definition at line 6132 of file Card.cs.

◆ LevelUp()

void Card.LevelUp ( )

Definition at line 3645 of file Card.cs.

◆ LookAt() [1/2]

virtual void Card.LookAt ( Card c)
virtual

Definition at line 6191 of file Card.cs.

◆ LookAt() [2/2]

virtual void Card.LookAt ( Point p)
virtual

Definition at line 6196 of file Card.cs.

◆ MakeFigureFrom()

void Card.MakeFigureFrom ( string id)

Definition at line 5786 of file Card.cs.

◆ MakeFoodFrom() [1/2]

Card Card.MakeFoodFrom ( Card c)

Definition at line 5640 of file Card.cs.

◆ MakeFoodFrom() [2/2]

Card Card.MakeFoodFrom ( string _id)

Definition at line 5634 of file Card.cs.

◆ MakeFoodRef()

void Card.MakeFoodRef ( Card c1,
Card c2 = null )

Definition at line 5720 of file Card.cs.

◆ MakeRefFrom() [1/2]

void Card.MakeRefFrom ( Card c1,
Card c2 = null )

Definition at line 5798 of file Card.cs.

◆ MakeRefFrom() [2/2]

void Card.MakeRefFrom ( string id)

Definition at line 5792 of file Card.cs.

◆ Mod()

void Card.Mod ( )

Definition at line 1061 of file Card.cs.

◆ ModCharge()

void Card.ModCharge ( int a,
bool destroy = false )

Definition at line 4383 of file Card.cs.

◆ ModCurrency()

void Card.ModCurrency ( int a,
string id = "money" )

Definition at line 4395 of file Card.cs.

◆ ModEncLv()

void Card.ModEncLv ( int a)

Definition at line 4301 of file Card.cs.

◆ ModExp() [1/2]

void Card.ModExp ( int ele,
int a )

Definition at line 3226 of file Card.cs.

◆ ModExp() [2/2]

void Card.ModExp ( string alias,
int a )

Definition at line 3220 of file Card.cs.

◆ ModNum()

void Card.ModNum ( int a,
bool notify = true )

Definition at line 4070 of file Card.cs.

◆ MoveImmediate()

unsafe void Card.MoveImmediate ( Point p,
bool focus = true,
bool cancelAI = true )

Definition at line 5828 of file Card.cs.

◆ NotifyAddThing()

void Card.NotifyAddThing ( Thing t,
int num )

Definition at line 3763 of file Card.cs.

◆ OnBeforeCreate()

virtual void Card.OnBeforeCreate ( )
virtual

Definition at line 3517 of file Card.cs.

◆ OnChildNumChange()

void Card.OnChildNumChange ( Card c)

Implements ICardParent.

Definition at line 4169 of file Card.cs.

◆ OnCreate()

virtual void Card.OnCreate ( int genLv)
virtual

Definition at line 3522 of file Card.cs.

◆ OnDeserialized()

virtual void Card.OnDeserialized ( )
protectedvirtual

Definition at line 3406 of file Card.cs.

◆ OnInspect()

void Card.OnInspect ( )

Implements IInspect.

Definition at line 7794 of file Card.cs.

◆ OnLand()

virtual void Card.OnLand ( )
virtual

Definition at line 5898 of file Card.cs.

◆ OnSerializing()

virtual void Card.OnSerializing ( )
protectedvirtual

Definition at line 3376 of file Card.cs.

◆ OnSimulateHour()

virtual void Card.OnSimulateHour ( VirtualDate date)
virtual

Definition at line 6578 of file Card.cs.

◆ PlayAnime() [1/2]

void Card.PlayAnime ( AnimeID id,
bool force = false )

Definition at line 6138 of file Card.cs.

◆ PlayAnime() [2/2]

void Card.PlayAnime ( AnimeID id,
Point dest,
bool force = false )

Definition at line 6144 of file Card.cs.

◆ PlayAnimeLoot()

void Card.PlayAnimeLoot ( )

Definition at line 6150 of file Card.cs.

◆ PlayEffect() [1/2]

unsafe void Card.PlayEffect ( int ele,
bool useRenderPos = true,
float range = 0f )

Definition at line 6166 of file Card.cs.

◆ PlayEffect() [2/2]

unsafe Effect Card.PlayEffect ( string id,
bool useRenderPos = true,
float range = 0f,
Vector3 fix = default(Vector3) )

Definition at line 6156 of file Card.cs.

◆ PlaySound()

SoundSource Card.PlaySound ( string id,
float v = 1f,
bool spatial = true )

Definition at line 6118 of file Card.cs.

◆ PlaySoundDrop()

void Card.PlaySoundDrop ( bool spatial = true)

Definition at line 6112 of file Card.cs.

◆ PlaySoundHold()

void Card.PlaySoundHold ( bool spatial = true)

Definition at line 6106 of file Card.cs.

◆ RecalculateFOV()

void Card.RecalculateFOV ( )

Definition at line 6342 of file Card.cs.

◆ ReferenceId()

string Card.ReferenceId ( )

Implements IGlobalValue.

Definition at line 3411 of file Card.cs.

◆ RefreshColor()

void Card.RefreshColor ( )

Definition at line 5990 of file Card.cs.

◆ RemoveBacker()

void Card.RemoveBacker ( )

Definition at line 6997 of file Card.cs.

◆ RemoveCard()

void Card.RemoveCard ( Card c)

Implements ICardParent.

Definition at line 3757 of file Card.cs.

◆ RemoveEditorTag()

void Card.RemoveEditorTag ( EditorTag tag)

Definition at line 2419 of file Card.cs.

◆ RemoveThing()

void Card.RemoveThing ( Thing thing)

Definition at line 3888 of file Card.cs.

◆ RemoveThings()

void Card.RemoveThings ( )

Definition at line 3879 of file Card.cs.

◆ RenderMarker()

unsafe void Card.RenderMarker ( Point point,
bool active,
HitResult result,
bool main,
int dir,
bool useCurrentPosition = false )

Definition at line 6277 of file Card.cs.

◆ ResistLv()

int Card.ResistLv ( int res)

Definition at line 5914 of file Card.cs.

◆ ResistLvFrom()

int Card.ResistLvFrom ( int ele)

Definition at line 5908 of file Card.cs.

◆ Rotate()

virtual void Card.Rotate ( bool reverse = false)
virtual

Definition at line 6201 of file Card.cs.

◆ Say() [1/3]

void Card.Say ( string lang,
Card c1,
Card c2,
string ref1 = null,
string ref2 = null )

Definition at line 6810 of file Card.cs.

◆ Say() [2/3]

void Card.Say ( string lang,
Card c1,
string ref1 = null,
string ref2 = null )

Definition at line 6820 of file Card.cs.

◆ Say() [3/3]

void Card.Say ( string lang,
string ref1 = null,
string ref2 = null )

Definition at line 6800 of file Card.cs.

◆ SayNothingHappans()

void Card.SayNothingHappans ( )

Definition at line 6794 of file Card.cs.

◆ SayRaw()

void Card.SayRaw ( string text,
string ref1 = null,
string ref2 = null )

Definition at line 6762 of file Card.cs.

◆ SecondaryCompare()

virtual int Card.SecondaryCompare ( UIList.SortMode m,
Card c )
virtual

Definition at line 7731 of file Card.cs.

◆ SetBlessedState()

virtual void Card.SetBlessedState ( BlessedState s)
virtual

Definition at line 4324 of file Card.cs.

◆ SetCensored()

void Card.SetCensored ( bool enable)

Definition at line 7672 of file Card.cs.

◆ SetCharge()

void Card.SetCharge ( int a)

Definition at line 4376 of file Card.cs.

◆ SetDeconstruct()

void Card.SetDeconstruct ( bool deconstruct)

Definition at line 7683 of file Card.cs.

◆ SetDir()

virtual void Card.SetDir ( int d)
virtual

Definition at line 6178 of file Card.cs.

◆ SetDirtyWeight()

void Card.SetDirtyWeight ( )

Definition at line 2284 of file Card.cs.

◆ SetEncLv()

void Card.SetEncLv ( int a)

Definition at line 4318 of file Card.cs.

◆ SetFreePos()

unsafe void Card.SetFreePos ( Point point)

Definition at line 6255 of file Card.cs.

◆ SetHidden()

void Card.SetHidden ( bool hide = true)

Definition at line 5810 of file Card.cs.

◆ SetImage() [1/2]

virtual void Card.SetImage ( Image image)
virtual

Definition at line 6063 of file Card.cs.

◆ SetImage() [2/2]

void Card.SetImage ( Image image,
int dir,
int idSkin = 0 )

Definition at line 6057 of file Card.cs.

◆ SetLv()

Card Card.SetLv ( int a)

Definition at line 3597 of file Card.cs.

◆ SetNoSell()

Thing Card.SetNoSell ( )

Definition at line 4063 of file Card.cs.

◆ SetNum()

Thing Card.SetNum ( int a)

Definition at line 4048 of file Card.cs.

◆ SetPaintData()

void Card.SetPaintData ( )

Definition at line 7011 of file Card.cs.

◆ SetPlaceState()

void Card.SetPlaceState ( PlaceState newState,
bool byPlayer = false )

Definition at line 4186 of file Card.cs.

◆ SetPriceFix()

Thing Card.SetPriceFix ( int a)

Definition at line 7140 of file Card.cs.

◆ SetRandomDir()

void Card.SetRandomDir ( )

Definition at line 6185 of file Card.cs.

◆ SetRandomLightColors()

void Card.SetRandomLightColors ( )

Definition at line 6511 of file Card.cs.

◆ SetRandomTalk()

void Card.SetRandomTalk ( )

Definition at line 6909 of file Card.cs.

◆ SetRandomTone()

void Card.SetRandomTone ( )

Definition at line 6919 of file Card.cs.

◆ SetRenderParam()

virtual void Card.SetRenderParam ( RenderParam p)
virtual

Definition at line 5965 of file Card.cs.

◆ SetReplica()

void Card.SetReplica ( bool on)

Definition at line 3734 of file Card.cs.

◆ SetSale()

void Card.SetSale ( bool sale)

Definition at line 7153 of file Card.cs.

◆ SetSortVal()

virtual void Card.SetSortVal ( UIList.SortMode m,
CurrencyType currency = CurrencyType::Money )
virtual

Definition at line 7701 of file Card.cs.

◆ SetSource()

virtual void Card.SetSource ( )
virtual

Definition at line 3527 of file Card.cs.

◆ ShouldTrySetDirtyInventory()

bool Card.ShouldTrySetDirtyInventory ( )

Definition at line 3939 of file Card.cs.

◆ ShowEmo()

void Card.ShowEmo ( Emo _emo = Emo::none,
float duration = 0f,
bool skipSame = true )

Definition at line 6074 of file Card.cs.

◆ SpawnLoot()

void Card.SpawnLoot ( Card origin)

Definition at line 5298 of file Card.cs.

◆ Split()

Thing Card.Split ( int a)

Definition at line 4036 of file Card.cs.

◆ Talk()

void Card.Talk ( string idTopic,
string ref1 = null,
string ref2 = null,
bool forceSync = false )

Definition at line 6684 of file Card.cs.

◆ TalkRaw()

void Card.TalkRaw ( string text,
string ref1 = null,
string ref2 = null,
bool forceSync = false )

Definition at line 6709 of file Card.cs.

◆ Teleport()

unsafe void Card.Teleport ( Point point,
bool silent = false,
bool force = false )

Definition at line 5855 of file Card.cs.

◆ Tick()

virtual void Card.Tick ( )
virtual

Definition at line 7119 of file Card.cs.

◆ ToString()

override string Card.ToString ( )

Definition at line 15 of file Card.cs.

◆ TryGetFoodName()

string Card.TryGetFoodName ( Card c)

Definition at line 5754 of file Card.cs.

◆ TryMakeRandomItem()

Thing Card.TryMakeRandomItem ( int lv = -1)

Definition at line 5513 of file Card.cs.

◆ TryPay()

bool Card.TryPay ( int a,
string id = "money" )

Definition at line 4356 of file Card.cs.

◆ TryReserve()

bool Card.TryReserve ( AIAct act)

Definition at line 37 of file Card.cs.

◆ TryStack()

void Card.TryStack ( Thing t)

Definition at line 6944 of file Card.cs.

◆ TryStackTo()

bool Card.TryStackTo ( Thing to)

Definition at line 3951 of file Card.cs.

◆ TryUnrestrain()

void Card.TryUnrestrain ( bool force = false,
Chara c = null )

Definition at line 7075 of file Card.cs.

◆ WriteNote()

virtual void Card.WriteNote ( UINote n,
Action< UINote > onWriteNote = null,
IInspect.NoteMode mode = IInspect::NoteMode::Default,
Recipe recipe = null )
virtual

Implements IInspect.

Definition at line 7839 of file Card.cs.

Member Data Documentation

◆ _bits1

BitArray32 Card._bits1

Definition at line 7995 of file Card.cs.

◆ _bits2

BitArray32 Card._bits2

Definition at line 7998 of file Card.cs.

◆ _colorInt

int Card._colorInt

Definition at line 7980 of file Card.cs.

◆ _ints

int [] Card._ints = new int[30]

Definition at line 7933 of file Card.cs.

◆ _material

SourceMaterial.Row Card._material

Definition at line 8013 of file Card.cs.

◆ angle

float Card.angle = 180f

Definition at line 7986 of file Card.cs.

◆ bio

Biography Card.bio

Definition at line 7949 of file Card.cs.

◆ bp

CardBlueprint Card.bp

Definition at line 7992 of file Card.cs.

◆ dirtyWeight

bool Card.dirtyWeight = true

Definition at line 8004 of file Card.cs.

◆ elements

Definition at line 7945 of file Card.cs.

◆ fov

Fov Card.fov

Definition at line 7968 of file Card.cs.

◆ id

string Card.id = ""

Definition at line 7937 of file Card.cs.

◆ isDestroyed

bool Card.isDestroyed

Definition at line 7989 of file Card.cs.

◆ lastEmo

Emo Card.lastEmo

Definition at line 8019 of file Card.cs.

◆ parent

ICardParent Card.parent

Definition at line 7965 of file Card.cs.

◆ placeState

PlaceState Card.placeState

Definition at line 8001 of file Card.cs.

◆ pos

Point Card.pos = new Point()

Definition at line 7971 of file Card.cs.

◆ props

Props Card.props

Definition at line 7959 of file Card.cs.

◆ renderer

CardRenderer Card.renderer

Definition at line 7974 of file Card.cs.

◆ reservedAct

AIAct Card.reservedAct

Definition at line 7956 of file Card.cs.

◆ roundTimer

float Card.roundTimer

Definition at line 7983 of file Card.cs.

◆ sockets

List<int> Card.sockets

Definition at line 7953 of file Card.cs.

◆ sortVal

int Card.sortVal

Definition at line 8028 of file Card.cs.

◆ things

ThingContainer Card.things = new ThingContainer()

Definition at line 7941 of file Card.cs.

◆ trait

Trait Card.trait

Definition at line 7962 of file Card.cs.

◆ turn

int Card.turn

Definition at line 7977 of file Card.cs.

Property Documentation

◆ _IsPC

bool Card._IsPC
get

Definition at line 2692 of file Card.cs.

◆ _placeState

PlaceState Card._placeState
getset

Definition at line 289 of file Card.cs.

◆ _x

int Card._x
getset

Definition at line 154 of file Card.cs.

◆ _z

int Card._z
getset

Definition at line 169 of file Card.cs.

◆ actorPrefab

virtual string Card.actorPrefab
get

Definition at line 2604 of file Card.cs.

◆ AliasMaterialOnCreate

virtual string Card.AliasMaterialOnCreate
get

Definition at line 2379 of file Card.cs.

◆ altitude

int Card.altitude
getset

Definition at line 214 of file Card.cs.

◆ ammoData

Thing Card.ammoData
getset

Definition at line 1982 of file Card.cs.

◆ autoRefuel

bool Card.autoRefuel
getset

Definition at line 694 of file Card.cs.

◆ blessedState

BlessedState Card.blessedState
getset

Definition at line 274 of file Card.cs.

◆ c_allowance

int Card.c_allowance
getset

Definition at line 1472 of file Card.cs.

◆ c_altName

string Card.c_altName
getset

Definition at line 1757 of file Card.cs.

◆ c_altName2

string Card.c_altName2
getset

Definition at line 1772 of file Card.cs.

◆ c_ammo

int Card.c_ammo
getset

Definition at line 1622 of file Card.cs.

◆ c_bedType

BedType Card.c_bedType
getset

Definition at line 1069 of file Card.cs.

◆ c_bill

int Card.c_bill
getset

Definition at line 1427 of file Card.cs.

◆ c_bossType

BossType Card.c_bossType
getset

Definition at line 1367 of file Card.cs.

◆ c_charaList

CharaList Card.c_charaList
getset

Definition at line 2092 of file Card.cs.

◆ c_charges

int Card.c_charges
getset

Definition at line 1412 of file Card.cs.

◆ c_color

string Card.c_color
getset

Definition at line 1712 of file Card.cs.

◆ c_containerSize

int Card.c_containerSize
getset

Definition at line 1502 of file Card.cs.

◆ c_containerUpgrade

ContainerUpgrade Card.c_containerUpgrade
getset

Definition at line 2057 of file Card.cs.

◆ c_context

string Card.c_context
getset

Definition at line 1847 of file Card.cs.

◆ c_copyContainer

Thing Card.c_copyContainer
getset

Definition at line 1997 of file Card.cs.

◆ c_dateStockExpire

int Card.c_dateStockExpire
getset

Definition at line 1382 of file Card.cs.

◆ c_daysWithGod

int Card.c_daysWithGod
getset

Definition at line 1637 of file Card.cs.

◆ c_diceDim

int Card.c_diceDim
getset

Definition at line 1532 of file Card.cs.

◆ c_DNA

DNA Card.c_DNA
getset

Definition at line 2077 of file Card.cs.

◆ c_dyeMat

int Card.c_dyeMat
getset

Definition at line 1322 of file Card.cs.

◆ c_editorTags

string Card.c_editorTags
getset

Definition at line 1877 of file Card.cs.

◆ c_editorTraitVal

string Card.c_editorTraitVal
getset

Definition at line 1892 of file Card.cs.

◆ c_equippedSlot

int Card.c_equippedSlot
getset

Definition at line 1084 of file Card.cs.

◆ c_fur

int Card.c_fur
getset

Definition at line 1487 of file Card.cs.

◆ c_genes

CharaGenes Card.c_genes
getset

Definition at line 2042 of file Card.cs.

◆ c_idAbility

string Card.c_idAbility
getset

Definition at line 1832 of file Card.cs.

◆ c_idBacker

int Card.c_idBacker
getset

Definition at line 1592 of file Card.cs.

◆ c_idDeity

string Card.c_idDeity
getset

Definition at line 1742 of file Card.cs.

◆ c_idEditor

string Card.c_idEditor
getset

Definition at line 1862 of file Card.cs.

◆ c_idJob

string Card.c_idJob
getset

Definition at line 1682 of file Card.cs.

◆ c_idMainElement

int Card.c_idMainElement
getset

Definition at line 1562 of file Card.cs.

◆ c_idPortrait

string Card.c_idPortrait
getset

Definition at line 1652 of file Card.cs.

◆ c_idRace

string Card.c_idRace
getset

Definition at line 1667 of file Card.cs.

◆ c_idRefCard

string Card.c_idRefCard
getset

Definition at line 1922 of file Card.cs.

◆ c_idRefCard2

string Card.c_idRefCard2
getset

Definition at line 1937 of file Card.cs.

◆ c_idRefName

string Card.c_idRefName
getset

Definition at line 1802 of file Card.cs.

◆ c_idRidePCC

string Card.c_idRidePCC
getset

Definition at line 1817 of file Card.cs.

◆ c_idTalk

string Card.c_idTalk
getset

Definition at line 1727 of file Card.cs.

◆ c_idTone

string Card.c_idTone
getset

Definition at line 1697 of file Card.cs.

◆ c_idTrait

string Card.c_idTrait
getset

Definition at line 1907 of file Card.cs.

◆ c_IDTState

int Card.c_IDTState
getset

Definition at line 1397 of file Card.cs.

◆ c_indexContainerIcon

int Card.c_indexContainerIcon
getset

Definition at line 1547 of file Card.cs.

◆ c_invest

int Card.c_invest
getset

Definition at line 1442 of file Card.cs.

◆ c_isImportant

bool Card.c_isImportant
getset

Definition at line 1159 of file Card.cs.

◆ c_isPrayed

bool Card.c_isPrayed
getset

Definition at line 1219 of file Card.cs.

◆ c_isTrained

bool Card.c_isTrained
getset

Definition at line 1204 of file Card.cs.

◆ c_lightColor

int Card.c_lightColor
getset

Definition at line 1234 of file Card.cs.

◆ c_lockedHard

bool Card.c_lockedHard
getset

Definition at line 1174 of file Card.cs.

◆ c_lockLv

int Card.c_lockLv
getset

Definition at line 1099 of file Card.cs.

◆ c_minionType

MinionType Card.c_minionType
getset

Definition at line 1129 of file Card.cs.

◆ c_note

string Card.c_note
getset

Definition at line 1952 of file Card.cs.

◆ c_originalHostility

Hostility Card.c_originalHostility
getset

Definition at line 1114 of file Card.cs.

◆ c_priceAdd

int Card.c_priceAdd
getset

Definition at line 1307 of file Card.cs.

◆ c_priceFix

int Card.c_priceFix
getset

Definition at line 1292 of file Card.cs.

◆ c_refText

string Card.c_refText
getset

Definition at line 1787 of file Card.cs.

◆ c_rescueState

RescueState Card.c_rescueState
getset

Definition at line 1352 of file Card.cs.

◆ c_revealLock

bool Card.c_revealLock
getset

Definition at line 1189 of file Card.cs.

◆ c_seed

int Card.c_seed
getset

Definition at line 1457 of file Card.cs.

◆ c_summonDuration

int Card.c_summonDuration
getset

Definition at line 1577 of file Card.cs.

◆ c_textureData

byte [] Card.c_textureData
getset

Definition at line 2148 of file Card.cs.

◆ c_uidMaster

int Card.c_uidMaster
getset

Definition at line 1607 of file Card.cs.

◆ c_uidRefCard

int Card.c_uidRefCard
getset

Definition at line 1276 of file Card.cs.

◆ c_uidZone

int Card.c_uidZone
getset

Definition at line 1260 of file Card.cs.

◆ c_uniqueData

UniqueData Card.c_uniqueData
getset

Definition at line 1967 of file Card.cs.

◆ c_upgrades

CharaUpgrade Card.c_upgrades
getset

Definition at line 2027 of file Card.cs.

◆ c_vomit

int Card.c_vomit
getset

Definition at line 1144 of file Card.cs.

◆ c_weight

int Card.c_weight
getset

Definition at line 1517 of file Card.cs.

◆ c_windowSaveData

Window.SaveData Card.c_windowSaveData
getset

Definition at line 2012 of file Card.cs.

◆ CanInspect

bool Card.CanInspect
get

Implements IInspect.

Definition at line 7800 of file Card.cs.

◆ category

SourceCategory.Row Card.category
get

Definition at line 2349 of file Card.cs.

◆ Cell

Cell Card.Cell
get

Definition at line 2426 of file Card.cs.

◆ CHA

int Card.CHA
get

Definition at line 3170 of file Card.cs.

◆ Chara

virtual Chara Card.Chara
get

Definition at line 2450 of file Card.cs.

◆ ChildrenAndSelfWeight

int Card.ChildrenAndSelfWeight
get

Definition at line 2309 of file Card.cs.

◆ ChildrenAndSelfWeightSingle

int Card.ChildrenAndSelfWeightSingle
get

Definition at line 2319 of file Card.cs.

◆ ChildrenWeight

int Card.ChildrenWeight
get

Definition at line 2250 of file Card.cs.

◆ colorInt

int Card.colorInt
get

Definition at line 69 of file Card.cs.

◆ decay

int Card.decay
getset

Definition at line 199 of file Card.cs.

◆ DefaultLV

int Card.DefaultLV
get

Definition at line 2240 of file Card.cs.

◆ DefaultMaterial

virtual SourceMaterial.Row Card.DefaultMaterial
get

Definition at line 3345 of file Card.cs.

◆ DEX

int Card.DEX
get

Definition at line 3110 of file Card.cs.

◆ dir

int Card.dir
getset

Definition at line 124 of file Card.cs.

◆ disableAutoToggle

bool Card.disableAutoToggle
getset

Definition at line 664 of file Card.cs.

◆ DMG

int Card.DMG
get

Definition at line 3090 of file Card.cs.

◆ DV

virtual int Card.DV
get

Definition at line 3060 of file Card.cs.

◆ DyeMat

SourceMaterial.Row Card.DyeMat
get

Definition at line 2162 of file Card.cs.

◆ encLV

int Card.encLV
getset

Definition at line 334 of file Card.cs.

◆ END

int Card.END
get

Definition at line 3120 of file Card.cs.

◆ ExistsOnMap

bool Card.ExistsOnMap
get

Definition at line 2484 of file Card.cs.

◆ exp

int Card.exp
getset

Definition at line 424 of file Card.cs.

◆ ExpToNext

int Card.ExpToNext
get

Definition at line 2230 of file Card.cs.

◆ FameLv

int Card.FameLv
get

Definition at line 3012 of file Card.cs.

◆ feat

int Card.feat
getset

Definition at line 394 of file Card.cs.

◆ flipX

virtual bool Card.flipX
get

Definition at line 2584 of file Card.cs.

◆ freePos

bool Card.freePos
getset

Definition at line 559 of file Card.cs.

◆ fx

float Card.fx
getset

Definition at line 244 of file Card.cs.

◆ fy

float Card.fy
getset

Definition at line 259 of file Card.cs.

◆ H

int Card.H
get

Definition at line 3251 of file Card.cs.

◆ HasContainerSize

bool Card.HasContainerSize
get

Definition at line 3321 of file Card.cs.

◆ HasHost

virtual bool Card.HasHost
get

Definition at line 3355 of file Card.cs.

◆ HIT

int Card.HIT
get

Definition at line 3080 of file Card.cs.

◆ HostRenderer

CardRenderer Card.HostRenderer
get

Definition at line 6749 of file Card.cs.

◆ hp

int Card.hp
getset

Definition at line 229 of file Card.cs.

◆ idMaterial

int Card.idMaterial
getset

Definition at line 109 of file Card.cs.

◆ idSkin

int Card.idSkin
getset

Definition at line 379 of file Card.cs.

◆ ignoreAutoPick

bool Card.ignoreAutoPick
getset

Definition at line 544 of file Card.cs.

◆ ignoreStackHeight

bool Card.ignoreStackHeight
getset

Definition at line 709 of file Card.cs.

◆ InspectName

string Card.InspectName
get

Implements IInspect.

Definition at line 7810 of file Card.cs.

◆ InspectPoint

Point Card.InspectPoint
get

Implements IInspect.

Definition at line 7820 of file Card.cs.

◆ InspectPosition

Vector3 Card.InspectPosition
get

Implements IInspect.

Definition at line 7830 of file Card.cs.

◆ INT

int Card.INT
get

Definition at line 3180 of file Card.cs.

◆ invX

int Card.invX
getset

Definition at line 2173 of file Card.cs.

◆ invY

int Card.invY
getset

Definition at line 2188 of file Card.cs.

◆ isAcidproof

bool Card.isAcidproof
getset

Definition at line 769 of file Card.cs.

◆ IsAgent

bool Card.IsAgent
get

Definition at line 2872 of file Card.cs.

◆ IsAliveInCurrentZone

virtual bool Card.IsAliveInCurrentZone
get

Definition at line 2594 of file Card.cs.

◆ IsAmmo

bool Card.IsAmmo
get

Definition at line 2862 of file Card.cs.

◆ isBackerContent

bool Card.isBackerContent
get

Definition at line 1038 of file Card.cs.

◆ IsBlessed

bool Card.IsBlessed
get

Definition at line 2892 of file Card.cs.

◆ isBroken

bool Card.isBroken
getset

Definition at line 829 of file Card.cs.

◆ isCensored

bool Card.isCensored
getset

Definition at line 454 of file Card.cs.

◆ isChara

virtual bool Card.isChara
get

Definition at line 2474 of file Card.cs.

◆ IsContainer

bool Card.IsContainer
get

Definition at line 2504 of file Card.cs.

◆ isCopy

bool Card.isCopy
getset

Definition at line 1009 of file Card.cs.

◆ isCrafted

bool Card.isCrafted
getset

Definition at line 904 of file Card.cs.

◆ IsCursed

bool Card.IsCursed
get

Definition at line 2902 of file Card.cs.

◆ IsDeadOrSleeping

virtual bool Card.IsDeadOrSleeping
get

Definition at line 2554 of file Card.cs.

◆ IsDecayed

bool Card.IsDecayed
get

Definition at line 2962 of file Card.cs.

◆ isDeconstructing

bool Card.isDeconstructing
getset

Definition at line 469 of file Card.cs.

◆ IsDisabled

virtual bool Card.IsDisabled
get

Definition at line 2564 of file Card.cs.

◆ isDyed

bool Card.isDyed
getset

Definition at line 484 of file Card.cs.

◆ isElemental

bool Card.isElemental
getset

Definition at line 814 of file Card.cs.

◆ IsEquipment

bool Card.IsEquipment
get

Definition at line 2782 of file Card.cs.

◆ IsEquipmentOrRanged

bool Card.IsEquipmentOrRanged
get

Definition at line 2822 of file Card.cs.

◆ isFireproof

bool Card.isFireproof
getset

Definition at line 754 of file Card.cs.

◆ isFloating

bool Card.isFloating
getset

Definition at line 724 of file Card.cs.

◆ IsFood

bool Card.IsFood
get

Definition at line 2792 of file Card.cs.

◆ IsFresn

bool Card.IsFresn
get

Definition at line 2982 of file Card.cs.

◆ IsFurniture

bool Card.IsFurniture
get

Definition at line 2882 of file Card.cs.

◆ isGifted

bool Card.isGifted
getset

Definition at line 889 of file Card.cs.

◆ IsGlobal

virtual bool Card.IsGlobal
get

Definition at line 2942 of file Card.cs.

◆ isHidden

bool Card.isHidden
getset

Definition at line 574 of file Card.cs.

◆ IsHotItem

bool Card.IsHotItem
get

Definition at line 83 of file Card.cs.

◆ IsIdentified

bool Card.IsIdentified
get

Definition at line 3265 of file Card.cs.

◆ IsImportant

bool Card.IsImportant
get

Definition at line 2534 of file Card.cs.

◆ isImported

bool Card.isImported
getset

Definition at line 679 of file Card.cs.

◆ IsInstalled

bool Card.IsInstalled
get

Definition at line 3285 of file Card.cs.

◆ isLeashed

bool Card.isLeashed
getset

Definition at line 964 of file Card.cs.

◆ IsLightsource

bool Card.IsLightsource
get

Definition at line 2772 of file Card.cs.

◆ isLostProperty

bool Card.isLostProperty
getset

Definition at line 919 of file Card.cs.

◆ IsMale

bool Card.IsMale
get

Definition at line 3295 of file Card.cs.

◆ isMasked

bool Card.isMasked
getset

Definition at line 649 of file Card.cs.

◆ IsMeleeWeapon

bool Card.IsMeleeWeapon
get

Definition at line 2832 of file Card.cs.

◆ IsMinion

virtual bool Card.IsMinion
get

Definition at line 2722 of file Card.cs.

◆ isModified

bool Card.isModified
getset

Definition at line 499 of file Card.cs.

◆ IsMoving

virtual bool Card.IsMoving
get

Definition at line 2574 of file Card.cs.

◆ IsMultisize

virtual bool Card.IsMultisize
get

Definition at line 2752 of file Card.cs.

◆ IsNegativeGift

bool Card.IsNegativeGift
get

Definition at line 3305 of file Card.cs.

◆ isNew

bool Card.isNew
getset

Definition at line 514 of file Card.cs.

◆ isNPCProperty

bool Card.isNPCProperty
getset

Definition at line 604 of file Card.cs.

◆ isOn

bool Card.isOn
getset

Definition at line 589 of file Card.cs.

◆ IsPC

virtual bool Card.IsPC
get

Definition at line 2682 of file Card.cs.

◆ IsPCC

virtual bool Card.IsPCC
get

Definition at line 2702 of file Card.cs.

◆ IsPCFaction

virtual bool Card.IsPCFaction
get

Definition at line 2922 of file Card.cs.

◆ IsPCFactionMinion

virtual bool Card.IsPCFactionMinion
get

Definition at line 2742 of file Card.cs.

◆ IsPCFactionOrMinion

bool Card.IsPCFactionOrMinion
get

Definition at line 2932 of file Card.cs.

◆ IsPCParty

virtual bool Card.IsPCParty
get

Definition at line 2712 of file Card.cs.

◆ IsPCPartyMinion

virtual bool Card.IsPCPartyMinion
get

Definition at line 2732 of file Card.cs.

◆ isPlayerCreation

bool Card.isPlayerCreation
getset

Definition at line 529 of file Card.cs.

◆ IsPowerful

bool Card.IsPowerful
get

Definition at line 2524 of file Card.cs.

◆ IsRangedWeapon

bool Card.IsRangedWeapon
get

Definition at line 2842 of file Card.cs.

◆ isReplica

bool Card.isReplica
getset

Definition at line 784 of file Card.cs.

◆ isRestocking

bool Card.isRestocking
getset

Definition at line 1024 of file Card.cs.

◆ isRestrained

bool Card.isRestrained
getset

Definition at line 619 of file Card.cs.

◆ IsRestrainedResident

bool Card.IsRestrainedResident
get

Definition at line 2912 of file Card.cs.

◆ isRoofItem

bool Card.isRoofItem
getset

Definition at line 634 of file Card.cs.

◆ IsRotting

bool Card.IsRotting
get

Definition at line 2972 of file Card.cs.

◆ isSale

bool Card.isSale
getset

Definition at line 994 of file Card.cs.

◆ isStolen

bool Card.isStolen
getset

Definition at line 979 of file Card.cs.

◆ isSubsetCard

bool Card.isSubsetCard
getset

Definition at line 844 of file Card.cs.

◆ isSummon

bool Card.isSummon
getset

Definition at line 799 of file Card.cs.

◆ isSynced

virtual bool Card.isSynced
get

Definition at line 2494 of file Card.cs.

◆ isThing

virtual bool Card.isThing
get

Definition at line 2464 of file Card.cs.

◆ IsThrownWeapon

bool Card.IsThrownWeapon
get

Definition at line 2852 of file Card.cs.

◆ IsToolbelt

bool Card.IsToolbelt
get

Definition at line 2762 of file Card.cs.

◆ IsUnique

bool Card.IsUnique
get

Definition at line 2514 of file Card.cs.

◆ IsVariation

bool Card.IsVariation
get

Definition at line 3050 of file Card.cs.

◆ IsWeapon

bool Card.IsWeapon
get

Definition at line 2812 of file Card.cs.

◆ isWeightChanged

bool Card.isWeightChanged
getset

Definition at line 739 of file Card.cs.

◆ LER

int Card.LER
get

Definition at line 3140 of file Card.cs.

◆ LightColor

Color Card.LightColor
get

Definition at line 1249 of file Card.cs.

◆ LightData

LightData Card.LightData
get

Definition at line 6364 of file Card.cs.

◆ LUC

int Card.LUC
get

Definition at line 3190 of file Card.cs.

◆ LV

int Card.LV
getset

Definition at line 409 of file Card.cs.

◆ MAG

int Card.MAG
get

Definition at line 3160 of file Card.cs.

◆ material

SourceMaterial.Row Card.material
get

Definition at line 2364 of file Card.cs.

◆ MaxDecay

virtual int Card.MaxDecay
get

Definition at line 2952 of file Card.cs.

◆ MaxHP

virtual int Card.MaxHP
get

Definition at line 2992 of file Card.cs.

◆ Name

string Card.Name
get

Definition at line 2644 of file Card.cs.

◆ NameSimple

string Card.NameSimple
get

Definition at line 2654 of file Card.cs.

◆ noMove

bool Card.noMove
getset

Definition at line 874 of file Card.cs.

◆ noSell

bool Card.noSell
getset

Definition at line 949 of file Card.cs.

◆ noShadow

bool Card.noShadow
getset

Definition at line 934 of file Card.cs.

◆ noSnow

bool Card.noSnow
getset

Definition at line 859 of file Card.cs.

◆ Num

int Card.Num
getset

Definition at line 139 of file Card.cs.

◆ parentCard

Card Card.parentCard
get

Definition at line 49 of file Card.cs.

◆ parentThing

Thing Card.parentThing
get

Definition at line 59 of file Card.cs.

◆ PER

int Card.PER
get

Definition at line 3130 of file Card.cs.

◆ posInvX

int Card.posInvX
getset

Definition at line 349 of file Card.cs.

◆ posInvY

int Card.posInvY
getset

Definition at line 364 of file Card.cs.

◆ Power

virtual int Card.Power
get

Definition at line 3002 of file Card.cs.

◆ Pref

virtual SourcePref Card.Pref
get

Definition at line 2544 of file Card.cs.

◆ PrefIndex

virtual int Card.PrefIndex
get

Definition at line 3036 of file Card.cs.

◆ PV

virtual int Card.PV
get

Definition at line 3070 of file Card.cs.

◆ Quality

int Card.Quality
get

Definition at line 4271 of file Card.cs.

◆ QualityLv

int Card.QualityLv
get

Definition at line 4281 of file Card.cs.

◆ qualityTier

int Card.qualityTier
getset

Definition at line 439 of file Card.cs.

◆ rarity

Rarity Card.rarity
getset

Definition at line 319 of file Card.cs.

◆ rarityLv

int Card.rarityLv
getset

Definition at line 304 of file Card.cs.

◆ refCard

CardRow Card.refCard
get

Definition at line 2202 of file Card.cs.

◆ refCard2

CardRow Card.refCard2
get

Definition at line 2216 of file Card.cs.

◆ refVal

int Card.refVal
getset

Definition at line 184 of file Card.cs.

◆ SelfWeight

virtual int Card.SelfWeight
get

Definition at line 2329 of file Card.cs.

◆ ShouldShowMsg

bool Card.ShouldShowMsg
get

Definition at line 6785 of file Card.cs.

◆ ShowFoodEnc

bool Card.ShowFoodEnc
get

Definition at line 2802 of file Card.cs.

◆ sourceBacker

SourceBacker.Row Card.sourceBacker
get

Definition at line 1048 of file Card.cs.

◆ sourceCard

virtual CardRow Card.sourceCard
get

Definition at line 2614 of file Card.cs.

◆ sourceRenderCard

virtual CardRow Card.sourceRenderCard
get

Definition at line 2624 of file Card.cs.

◆ STR

int Card.STR
get

Definition at line 3100 of file Card.cs.

◆ TextRarity

string Card.TextRarity
get

Definition at line 3275 of file Card.cs.

◆ Thing

virtual Thing Card.Thing
get

Definition at line 2436 of file Card.cs.

◆ ThisOrParentPos

Point Card.ThisOrParentPos
get

Definition at line 6093 of file Card.cs.

◆ Tiles

virtual int [] Card.Tiles
get

Definition at line 3026 of file Card.cs.

◆ TileType

TileType Card.TileType
get

Definition at line 2634 of file Card.cs.

◆ Tool

Thing Card.Tool
get

Definition at line 3331 of file Card.cs.

◆ uid

int Card.uid
getset

Definition at line 94 of file Card.cs.

◆ visitorState

VisitorState Card.visitorState
getset

Definition at line 1337 of file Card.cs.

◆ W

int Card.W
get

Definition at line 3237 of file Card.cs.

◆ WeightLimit

virtual int Card.WeightLimit
get

Definition at line 2339 of file Card.cs.

◆ WIL

int Card.WIL
get

Definition at line 3150 of file Card.cs.


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