Class:Character
This page documents the Character class for Lua scripting.
As an instanced class, it be accessed from Lua after assigning the instance to a variable, such as character
ProxyName
character.ProxyName
Type: System.String
{{{description}}}
Name
character.Name
Type: System.String
{{{description}}}
ProxySprite
character.ProxySprite
Type: RogueEssence.Dungeon.MonsterID
{{{description}}}
Appearance
character.Appearance
Type: RogueEssence.Dungeon.MonsterID
{{{description}}}
CurrentForm
character.CurrentForm
Type: RogueEssence.Dungeon.MonsterID
{{{description}}}
MaxHP
character.MaxHP
Type: System.Int32
{{{description}}}
ProxyAtk
character.ProxyAtk
Type: System.Int32
{{{description}}}
Atk
character.Atk
Type: System.Int32
{{{description}}}
BaseAtk
character.BaseAtk
Type: System.Int32
{{{description}}}
ProxyDef
character.ProxyDef
Type: System.Int32
{{{description}}}
Def
character.Def
Type: System.Int32
{{{description}}}
BaseDef
character.BaseDef
Type: System.Int32
{{{description}}}
ProxyMAtk
character.ProxyMAtk
Type: System.Int32
{{{description}}}
MAtk
character.MAtk
Type: System.Int32
{{{description}}}
BaseMAtk
character.BaseMAtk
Type: System.Int32
{{{description}}}
ProxyMDef
character.ProxyMDef
Type: System.Int32
{{{description}}}
MDef
character.MDef
Type: System.Int32
{{{description}}}
BaseMDef
character.BaseMDef
Type: System.Int32
{{{description}}}
ProxySpeed
character.ProxySpeed
Type: System.Int32
{{{description}}}
Speed
character.Speed
Type: System.Int32
{{{description}}}
BaseSpeed
character.BaseSpeed
Type: System.Int32
{{{description}}}
Skills
character.Skills
Type: System.Collections.Generic.List{RogueEssence.Dungeon.BackReference{RogueEssence.Dungeon.Skill
{{{description}}}
|notes=
}}
Element1
character.Element1
Type: System.String
{{{description}}}
Element2
character.Element2
Type: System.String
{{{description}}}
Intrinsics
character.Intrinsics
Type: System.Collections.Generic.List{RogueEssence.Dungeon.BackReference{RogueEssence.Dungeon.Intrinsic
{{{description}}}
|notes=
}}
EquippedItem
character.EquippedItem
Type: RogueEssence.Dungeon.InvItem
{{{description}}}
Absentee
character.Absentee
Type: System.Boolean
If turned on, this entity is considered NOT a part of the adventure for the duration of that adventure.
LuaData
character.LuaData
Type: NLua.LuaTable
Lua table containing the data for the object.
Ideally, implement the interface by using a OptionalAttribute field for this one.
MovementSpeed
character.MovementSpeed
Type: System.Int32
{{{description}}}
ChargeBoost
character.ChargeBoost
Type: System.Int32
{{{description}}}
CharLoc
character.CharLoc
Type: RogueElements.Loc
Position on the map grid in tiles.
CharDir
character.CharDir
Type: RogueElements.Dir8
Character's direction.
HideShadow
character.HideShadow
Type: System.Boolean
{{{description}}}
HP
character.HP
Type: System.Int32
{{{description}}}
HPRemainder
character.HPRemainder
Type: System.Int32
{{{description}}}
Fullness
character.Fullness
Type: System.Int32
{{{description}}}
FullnessRemainder
character.FullnessRemainder
Type: System.Int32
{{{description}}}
MaxFullness
character.MaxFullness
Type: System.Int32
{{{description}}}
Dead
character.Dead
Type: System.Boolean
{{{description}}}
StatusEffects
character.StatusEffects
Type: System.Collections.Generic.Dictionary{System.String,RogueEssence.Dungeon.StatusEffect}
{{{description}}}
MissChain
character.MissChain
Type: System.Int32
Times missed
MustHitNext
character.MustHitNext
Type: System.Boolean
{{{description}}}
TurnWait
character.TurnWait
Type: System.Int32
The number of turns this character must wait before being able to move again.
TurnUsed
character.TurnUsed
Type: System.Boolean
Whether the character has made an action during this map turn. Only one action per map turn permitted.
EXPMarked
character.EXPMarked
Type: System.Boolean
{{{description}}}
Tactic
character.Tactic
Type: RogueEssence.Data.AITactic
{{{description}}}
Mobility
character.Mobility
Type: RogueEssence.Data.TerrainData.Mobility
{{{description}}}
CantWalk
character.CantWalk
Type: System.Boolean
{{{description}}}
ItemDisabled
character.ItemDisabled
Type: System.Boolean
Will prevent the passive item effects. Does not prevent active use.
IntrinsicDisabled
character.IntrinsicDisabled
Type: System.Boolean
Prevents passive intrinsic effects
CanRemoveStuck
character.CanRemoveStuck
Type: System.Boolean
{{{description}}}
StopItemAtHit
character.StopItemAtHit
Type: System.Boolean
{{{description}}}
ForceAI
character.ForceAI
Type: System.Boolean
Will act as AI even if controlled
MovesScrambled
character.MovesScrambled
Type: System.Boolean
Will move erratically
ChargeSaver
character.ChargeSaver
Type: System.Boolean
{{{description}}}
WaitToAttack
character.WaitToAttack
Type: System.Boolean
The Wait command translates to attack.
CantInteract
character.CantInteract
Type: System.Boolean
Can't pick up/place/equip/take items, cant interact with ground/people.
EnemyOfFriend
character.EnemyOfFriend
Type: System.Boolean
Treated as a foe by friends in combat
AttackFriend
character.AttackFriend
Type: System.Boolean
Treats friends as foes in and out of combat
TileSight
character.TileSight
Type: RogueEssence.Dungeon.Map.SightRange
{{{description}}}
CharSight
character.CharSight
Type: RogueEssence.Dungeon.Map.SightRange
{{{description}}}
Unidentifiable
character.Unidentifiable
Type: System.Boolean
{{{description}}}
Unlocatable
character.Unlocatable
Type: System.Boolean
{{{description}}}
SeeAllChars
character.SeeAllChars
Type: System.Boolean
{{{description}}}
SeeItems
character.SeeItems
Type: System.Boolean
{{{description}}}
SeeWallItems
character.SeeWallItems
Type: System.Boolean
{{{description}}}
SeeTraps
character.SeeTraps
Type: System.Boolean
{{{description}}}
CharStates
character.CharStates
Type: RogueEssence.Dungeon.StateCollection{RogueEssence.Dungeon.CharState}
{{{description}}}
BackRef
character.BackRef
Type: RogueEssence.Dungeon.TempCharBackRef
{{{description}}}
CharLocFrom
character.CharLocFrom
Type: RogueElements.Loc
{{{description}}}
ActionDone
character.ActionDone
Type: System.Boolean
{{{description}}}
MapLoc
character.MapLoc
Type: RogueElements.Loc
Position on the map in pixels.
LocHeight
character.LocHeight
Type: System.Int32
{{{description}}}
MAX_SKILL_SLOTS
character.MAX_SKILL_SLOTS
Type: System.Int32
{{{description}}}
MAX_INTRINSIC_SLOTS
character.MAX_INTRINSIC_SLOTS
Type: System.Int32
{{{description}}}
Nickname
character.Nickname
Type: System.String
{{{description}}}
BaseName
character.BaseName
Type: System.String
{{{description}}}
OriginalUUID
character.OriginalUUID
Type: System.String
{{{description}}}
OriginalTeam
character.OriginalTeam
Type: System.String
{{{description}}}
BaseForm
character.BaseForm
Type: RogueEssence.Dungeon.MonsterID
{{{description}}}
Level
character.Level
Type: System.Int32
{{{description}}}
EXP
character.EXP
Type: System.Int32
{{{description}}}
MaxHPBonus
character.MaxHPBonus
Type: System.Int32
{{{description}}}
AtkBonus
character.AtkBonus
Type: System.Int32
{{{description}}}
DefBonus
character.DefBonus
Type: System.Int32
{{{description}}}
MAtkBonus
character.MAtkBonus
Type: System.Int32
{{{description}}}
MDefBonus
character.MDefBonus
Type: System.Int32
{{{description}}}
SpeedBonus
character.SpeedBonus
Type: System.Int32
{{{description}}}
BaseSkills
character.BaseSkills
Type: System.Collections.Generic.List{RogueEssence.Dungeon.SlotSkill}
{{{description}}}
BaseIntrinsics
character.BaseIntrinsics
Type: System.Collections.Generic.List{System.String}
{{{description}}}
FormIntrinsicSlot
character.FormIntrinsicSlot
Type: System.Int32
{{{description}}}
Relearnables
character.Relearnables
Type: System.Collections.Generic.Dictionary{System.String,System.Boolean}
{{{description}}}
Discriminator
character.Discriminator
Type: System.Int32
{{{description}}}
MetAt
character.MetAt
Type: System.String
{{{description}}}
MetLoc
character.MetLoc
Type: RogueEssence.Dungeon.ZoneLoc
{{{description}}}
DefeatAt
character.DefeatAt
Type: System.String
{{{description}}}
DefeatLoc
character.DefeatLoc
Type: RogueEssence.Dungeon.ZoneLoc
{{{description}}}
IsFounder
character.IsFounder
Type: System.Boolean
Cannot be removed from assembly.
IsPartner
character.IsPartner
Type: System.Boolean
Cannot be removed from team.
NameLocked
character.NameLocked
Type: System.Boolean
{{{description}}}
IsFavorite
character.IsFavorite
Type: System.Boolean
{{{description}}}
Unrecruitable
character.Unrecruitable
Type: System.Boolean
{{{description}}}
ActionEvents
character.ActionEvents
Type: System.Collections.Generic.List{RogueEssence.Dungeon.BattleEvent}
{{{description}}}
ScriptVars
character.ScriptVars
Type: RogueEssence.Script.LuaTableContainer
{{{description}}}
References
https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Dungeon/Characters/Character.cs
https://github.com/RogueCollab/RogueEssence/blob/master/RogueEssence/Dungeon/Characters/CharData.cs
