The superclass of Game_Actor and Game_Enemy. It contains methods for sprites and actions.
Extends
Methods
action(index)Game_Action
- Get the action at the given index
Name Type Description indexnumber The index to get the action from Returns:
Type Description Game_Action The action actionPlusSet()Arrayinherited
- Get action plus traits set
Returns:
Type Description Array Trait values for action plus - Add a buff to the battler by id
Name Type Description paramIdnumber Id of the param to buff turnsnumber Amount of turns the buff lasts - Add a debuff to the battler by id
Name Type Description paramIdnumber Id of the param to debuff turnsnumber Amount of turns the debuff lasts addNewState(stateId)inherited
- Adds a new state to the battler by id
Name Type Description stateIdnumber The state id to add addParam(paramId, value)inherited
- Adds a bonus to a parameter by id
Name Type Description paramIdnumber The parameter id to add to valuenumber The amount to add - Add a state to the battler by id
Name Type Description stateIdnumber Id of state to be added addedSkillTypes()Arrayinherited
- Get the added skill types
Returns:
Type Description Array The added skill types addedSkills()Arrayinherited
- Get the added skills
Returns:
Type Description Array The added skills allIcons()Arrayinherited
- Get state and buff icons
Returns:
Type Description Array Array of state and buff icon indexes allTraits()Arrayinherited
- Get an array of all traits from all trait objects
Returns:
Type Description Array Array of all traits - Shows the battler
- Applies a TPB penalty
attackElements()Arrayinherited
- Get the attack elements trait set
Returns:
Type Description Array Array of attack element trait data ids attackSkillId()numberinherited
- Get the attack skill id
Returns:
Type Description number The attack skill id attackSpeed()numberinherited
- Get the attack speed
Returns:
Type Description number The attack speed attackStates()Arrayinherited
- Get the attack state trait set
Returns:
Type Description Array Array of attack state trait data ids attackStatesRate(stateId)numberinherited
- Get the attack state rate for a given state id
Name Type Description stateIdnumber The state id Returns:
Type Description number The state rate attackTimesAdd()numberinherited
- Get the attack times
Returns:
Type Description number The attack times buff(paramId)numberinherited
- Get a buff for a parameter by id
Name Type Description paramIdnumber The id of the parameter Returns:
Type Description number The buff that parameter has buffIconIndex(buffLevel, paramId)numberinherited
- Get a buff icon a specific buff
Name Type Description buffLevelnumber The buff level of the parameter paramIdnumber The id of the parameter Returns:
Type Description number The buff icon index buffIcons()Arrayinherited
- Get buff icons for buffs the battler has
Returns:
Type Description Array Array of buff icon indexes buffLength()numberinherited
- Get the amount of possible params to buff
Returns:
Type Description number Amount of buffs possible canAttack()booleaninherited
- Check if the battler can attack
Returns:
Type Description boolean True if the battler can attack canEquip(item)booleaninherited
- Check if an item can be equipped
Name Type Description itemObject The weapon/armor object Returns:
Type Description boolean True if the weapon/armor can be equipped canEquipArmor(item)booleaninherited
- Check if an armor can be equipped
Name Type Description itemObject The armor object Returns:
Type Description boolean True if the armor can be equipped canEquipWeapon(item)booleaninherited
- Check if a weapon can be equipped
Name Type Description itemObject The weapon object Returns:
Type Description boolean True if the weapon can be equipped canGuard()booleaninherited
- Check if the battler can guard
Returns:
Type Description boolean True if the battler can guard - Check if the battler can input
Returns:
Type Description boolean True if can input canMove()booleaninherited
- Check if the battler can move
Returns:
Type Description boolean True if can move canPaySkillCost(skill)booleaninherited
- Check if skill costs are payable
Name Type Description skillObject The skill object Returns:
Type Description boolean True if costs can be paid canUse(item)booleaninherited
- Check if an item or skill can be used
Name Type Description itemObject The item/skill object Returns:
Type Description boolean True if the item/skill can be used - Cancels a motion refresh
- Since:
- Version 1.1.0
- Gains tp based on damage
Name Type Description damageRatenumber The damage rate to base tp gain off - Clears the battler's actions
clearBuffs()inherited
- Clear buffs
- Clears the damage popup
- Clears an effect
- Clears a motion
clearParamPlus()inherited
- Clears param bonus effects
- Clears the result of an action
clearStates()inherited
- Clears states affecting the battler
- Clears tp
- Clears TPB charge time
- Clears the weapon animation
collapseType()numberinherited
- Get collapse type
Returns:
Type Description number The collapse type confusionLevel()numberinherited
- Determine the confusion level of the battler
Returns:
Type Description number Confusion level - Consumes the given item
Name Type Description itemObject The item object to consume currentAction()Game_Action
- Get the current action
Returns:
Type Description Game_Action The current action deathStateId()numberinherited
- Get the state id for the death state
Returns:
Type Description number The id of the death state debuffRate(paramId)numberinherited
- Get the debuff rate by id
Name Type Description paramIdnumber The id of the parameter Returns:
Type Description number The debuff rate decreaseBuff(paramId)inherited
- Decrease the buff for a parameter
Name Type Description paramIdnumber The id of the param to debuff - Marks the battler as not selected
- Kills the battler
- Get the effect type
Returns:
Type Description string The effect type elementRate(elementId)numberinherited
- Get the element rate by id
Name Type Description elementIdnumber The id of the element Returns:
Type Description number The element rate eraseBuff(paramId)inherited
- Erase a buff by param id
Name Type Description paramIdnumber The id of the param to erase buffs for eraseState(stateId)inherited
- Erases a state by id
Name Type Description stateIdnumber The id of the state to erase - Processing when there is an escape
- Finishes the TPB charge
- Force an action
Name Type Description skillIdnumber The skill id targetIndexnumber The target index - Gains an amount of hp
Name Type Description valuenumber The amount of hp to gain - Gains an amount of mp
Name Type Description valuenumber The amount of mp to gain - Gains an amount of tp without adding it to the action result
Name Type Description valuenumber The amount of tp to gain - Gains an amount of tp
Name Type Description valuenumber The amount of tp to gain guardSkillId()numberinherited
- Get the guard skill's id
Returns:
Type Description number The guard skill's id - Hides the battler
hpRate()numberinherited
- Get the battler's hp rate (hp / max hp)
Returns:
Type Description number The hp rate increaseBuff(paramId)inherited
- Increase the buff for a parameter
Name Type Description paramIdnumber The id of the param to buff - Initialize class variables
- Initialize tp
- Initialize the TPB charge time
Name Type Description advantageousboolean If charge time should be advantageous - Initialize TPB turn
- Initializes the class
- Check if the action state is acting
Returns:
Type Description boolean True if acting isActor()booleaninherited
- Check if the battler is an actor type
Returns:
Type Description boolean True if actor isAlive()booleaninherited
- Check if the battler is alive
Returns:
Type Description boolean True if alive isAppeared()booleaninherited
- Check if the battler is appeared (not hidden)
Returns:
Type Description boolean True if appeared isAutoBattle()booleaninherited
- Check if the battler has the auto battle special flag
Returns:
Type Description boolean True if auto battle isBuffAffected(paramId)booleaninherited
- Check if there is a buff for a parameter by id
Name Type Description paramIdnumber The id of the param to check Returns:
Type Description boolean True if that parameter has a buff isBuffExpired(paramId)booleaninherited
- Check if buff is expired by id
Name Type Description paramIdnumber The id of the param to check for expired buff Returns:
Type Description boolean True if the buff is expired isBuffOrDebuffAffected(paramId)booleaninherited
- Check if there is a buff or debuff for a parameter by id
Name Type Description paramIdnumber The id of the param to check Returns:
Type Description boolean True if that parameter has a buff or debuff - Check if the battler is chanting
Returns:
Type Description boolean True if chanting isConfused()booleaninherited
- Check if the battler is confused
Returns:
Type Description boolean True if confused - Check if a damage popup is requested
Returns:
Type Description boolean True if a damage popup has been requested isDead()booleaninherited
- Check if the battler is dead
Returns:
Type Description boolean True if dead isDeathStateAffected()booleaninherited
- Check if the battler is affected by the death state
Returns:
Type Description boolean True if the battler is affected by the state isDebuffAffected(paramId)booleaninherited
- Check if there is a debuff for a parameter by id
Name Type Description paramIdnumber The id of the param to check Returns:
Type Description boolean True if that parameter has a debuff isDualWield()booleaninherited
- Check if the battler is dual wield type
Returns:
Type Description boolean True if dual wield isDying()booleaninherited
- Check if the battler is low on hp
Returns:
Type Description boolean True if low on hp - Check if an effect is requested
Returns:
Type Description boolean True if an effect has been requested isEnemy()booleaninherited
- Check if the battler is an enemy type
Returns:
Type Description boolean True if enemy isEquipAtypeOk(atypeId)booleaninherited
- Check if an armor type is ok to equip
Name Type Description atypeIdnumber The armor type to check Returns:
Type Description boolean True if ok to equip isEquipTypeLocked(etypeId)booleaninherited
- Check if an equip type is locked
Name Type Description etypeIdnumber The equip type to check Returns:
Type Description boolean True if locked isEquipTypeSealed(etypeId)booleaninherited
- Check if an equip type is sealed
Name Type Description etypeIdnumber The equip type to check Returns:
Type Description boolean True if sealed isEquipWtypeOk(wtypeId)booleaninherited
- Check if a weapon type is ok to equip
Name Type Description wtypeIdnumber The weapon type to check Returns:
Type Description boolean True if ok to equip isGuard()booleaninherited
- Check if the battler has the guard special flag
Returns:
Type Description boolean True if guard - Check if the battler is guarding
Returns:
Type Description boolean True if guarding isHidden()booleaninherited
- Check if the battler is hidden
Returns:
Type Description boolean True if hidden - Check if the action state is inputting
Returns:
Type Description boolean True if inputting isMaxBuffAffected(paramId)booleaninherited
- Check if the maximum buff is on the parameter
Name Type Description paramIdnumber The id of the param to check Returns:
Type Description boolean True if that parameter has a maximum buff isMaxDebuffAffected(paramId)booleaninherited
- Check if the maximum debuff is on the parameter
Name Type Description paramIdnumber The id of the param to check Returns:
Type Description boolean True if that parameter has a maximum debuff - Check if a motion refresh is requested
Returns:
Type Description boolean True if a motion refresh has been requested - Check if a motion is requested
Returns:
Type Description boolean True if a motion has been requested isOccasionOk(item)booleaninherited
- Check if an item's occasion is met
Name Type Description itemObject The item object Returns:
Type Description boolean True if the occasion is met isPreserveTp()booleaninherited
- Check if the battler has the preserve tp special flag
Returns:
Type Description boolean True if preserve tp isRestricted()booleaninherited
- Check if the battler is restricted
Returns:
Type Description boolean True if restricted - Check if this is selected
Returns:
Type Description boolean True if selected isSkillSealed(skillId)booleaninherited
- Check if a skill is sealed
Name Type Description skillIdnumber The skill to check Returns:
Type Description boolean True if sealed isSkillTypeSealed(stypeId)booleaninherited
- Check if a skill type is sealed
Name Type Description stypeIdnumber The skill type to check Returns:
Type Description boolean True if sealed isSkillWtypeOk()booleaninherited
- Check if skill Wtype is ok
Returns:
Type Description boolean True if skill wtype is ok - Check if the state with the given id can be added to the battler
Name Type Description stateIdnumber Id of state to check Returns:
Type Description boolean True if the state can be added isStateAffected(stateId)booleaninherited
- Check if the battler is affected by a state by id
Name Type Description stateIdnumber The id of the state to check Returns:
Type Description boolean True if the battler is affected by the state isStateExpired(stateId)booleaninherited
- Check if a state is expired
Name Type Description stateIdnumber The id of the state to check Returns:
Type Description boolean True if the state is expired isStateResist(stateId)booleaninherited
- Check if a state is resisted
Name Type Description stateIdnumber The id of the state to check Returns:
Type Description boolean True if resisted - Check if the state with the given id is restricted
Name Type Description stateIdnumber Id of state to check Returns:
Type Description boolean True if the state is restricted isSubstitute()booleaninherited
- Check if the battler has the substitute special flag
Returns:
Type Description boolean True if substitute - Check if TPB is in the charged state
Returns:
Type Description boolean True if charged - Check if TPB is in the ready state
Returns:
Type Description boolean True if ready - Check if TPB is timed out
Returns:
Type Description boolean True if timed out - Check for turn end in TPB
Returns:
Type Description boolean True if turn ended - Check if the action state is undecided
Returns:
Type Description boolean True if undecided - Check if the action state is waiting
Returns:
Type Description boolean True if waiting - Check if a weapon animation is requested
Returns:
Type Description boolean True if a weapon animation has been requested - Make the action times
Returns:
Type Description number The action times - Make the battler's actions
- Make the battler's speed
- Makes the TPB actions
- Get the maximum amount for slip damage
Returns:
Type Description number Maximum slip damage amount maxTp()numberinherited
- Get the max tp the battler can have
Returns:
Type Description number Maximum tp value meetsItemConditions(item)booleaninherited
- Check if an item's conditions are met
Name Type Description itemObject The item object Returns:
Type Description boolean True if the conditions are met meetsSkillConditions(skill)booleaninherited
- Check if a skill's conditions are met
Name Type Description skillObject The skill object Returns:
Type Description boolean True if the conditions are met meetsUsableItemConditions(item)booleaninherited
- Check if an item's usable conditions are met
Name Type Description itemObject The item object Returns:
Type Description boolean True if the conditions are met mostImportantStateText()stringinherited
- Get the most important state's text (persists message)
Returns:
Type Description string The most important state's persist message - Get the motion type
Returns:
Type Description string The motion type mpRate()numberinherited
- Get the battler's mp rate (mp / max mp)
Returns:
Type Description number The mp rate - Get the amount of actions the battler has
Returns:
Type Description number Amount of actions - Processing when all actions are over
- Processing when a battle ends
- Processing when a battle starts
Name Type Description advantageousboolean If the battle is advantageous - Processing when damage occurs
Name Type Description valuenumber Amount of damage taken - Processing when a restriction is added
- Processing when TPB is charged
- Processing for when TPB is timed out
- Processing when a turn ends
overwriteBuffTurns(paramId, turns)inherited
- Overwrite a buff's turns remaining
Name Type Description paramIdnumber The id of the param to overwrite buff turns for turnsnumber The new amount of turns the buff will last for param(paramId)numberinherited
- Get the final parameter value id
Name Type Description paramIdnumber The id of the parameter Returns:
Type Description number The parameter value paramBase()numberinherited
- Get the base param.
Returns:
Type Description number The base param paramBasePlus(paramId)numberinherited
- Get the parameter base + plus by id
Name Type Description paramIdnumber The id of the parameter Returns:
Type Description number The parameter base added to parameter plus paramBuffRate(paramId)numberinherited
- Get the parameter buff rate by id
Name Type Description paramIdnumber The id of the parameter Returns:
Type Description number The parameter buff rate paramMax()numberinherited
- Get the maximum a parameter can be
Returns:
Type Description number The maximum valid value for this parameter paramMin(paramId)numberinherited
- Get the minimum a parameter can be
Name Type Description paramIdnumber The id of the parameter Returns:
Type Description number The minimum valid value for this parameter paramPlus(paramId)numberinherited
- Get the parameter bonus by id
Name Type Description paramIdnumber The id of the parameter Returns:
Type Description number The parameter bonus paramRate(paramId)numberinherited
- Get the parameter rate by id
Name Type Description paramIdnumber The id of the parameter Returns:
Type Description number The parameter rate partyAbility(abilityId)booleaninherited
- Check if there are traits with a party ability id
Name Type Description abilityIdnumber The ability id to check Returns:
Type Description boolean True if traits exist for the ability id paySkillCost(skill)inherited
- Pay the skill costs
Name Type Description skillObject The skill object - Perform an action. When called from Game_Battler, this does nothing.
- Perform an action end. When called from Game_Battler, this does nothing.
- Start an action
Name Type Description actionGame_Action The action to start - Perform a collapse. When called from Game_Battler, this does nothing.
- Perform a counter
- Perform a damage. When called from Game_Battler, this does nothing.
- Perform an evasion
- Perform a magic evasion
- Perform a miss
- Perform a recovery
- Perform a reflection
- Perform a substitute. When called from Game_Battler, this does nothing.
recoverAll()inherited
- Recover all for the battler
- Refresh the battler
- Regenerates everything (hp/mp/tp)
- Regenerates hp
- Regenerates mp
- Regenerates tp
- Remove all buffs
- Remove states that end after battle
- Remove a buff to the battler by id
Name Type Description paramIdnumber Id of the param to remove buffs for - Remove buffs when they expire
- Removes the current action
- Remove a state to the battler by id
Name Type Description stateIdnumber Id of state to be removed - Remove states set to auto remove
Name Type Description timingnumber The timing to check against for auto removal - Remove states that are removed by damage
- Requests an effect
Name Type Description effectTypestring The type of effect to request - Requests a motion
Name Type Description motionTypestring The type of motion to request - Requests a motion refresh
resetStateCounts(stateId)inherited
- Resets a state's turn counter by id
Name Type Description stateIdnumber The id of the state to reset restriction()numberinherited
- Get the highest restriction on the battler
Returns:
Type Description number The greatest restriction on the battler - Get the result of an action
Returns:
Type Description Game_ActionResult The action result revive()inherited
- Revives the battler
- Marks the battler as selected
- Set an action at the given index
Name Type Description indexnumber The index to set the action of actionGame_Action The action to set - Set the action state
Name Type Description actionStatestring The new action state setHp(hp)inherited
- Sets the battler's hp to the given value
Name Type Description hpnumber The new hp value - Set the last target
Name Type Description targetGame_Enemy|Game_Actor The last target setMp(mp)inherited
- Sets the battler's mp to the given value
Name Type Description mpnumber The new mp value setTp(tp)inherited
- Sets the battler's tp to the given value
Name Type Description tpnumber The new tp value - Check if charging should be delayed
Returns:
Type Description boolean True if delay is needed - Check if a damage popup should appear
Returns:
Type Description boolean True if should popup damage skillMpCost(skill)numberinherited
- Get the skill mp cost
Name Type Description skillObject The skill object Returns:
Type Description number Skill mp cost skillTpCost(skill)numberinherited
- Get the skill tp cost
Name Type Description skillObject The skill object Returns:
Type Description number Skill tp cost slotType()numberinherited
- Get the slot type
Returns:
Type Description number The slot type sortStates()inherited
- Sort the states affecting the battler by their priority
sparam(sparamId)numberinherited
- Get the s-parameter value by id
Name Type Description sparamIdnumber The id of the parameter Returns:
Type Description number The parameter value specialFlag(flagId)booleaninherited
- Check if there are traits with a special flag id
Name Type Description flagIdnumber The flag id to check Returns:
Type Description boolean True if traits exist for the flag id - Get the battler's speed
Returns:
Type Description number The battler's speed - Starts the damage popup
- Starts a TPB action
- Starts TPB casting
- Starts TPB turn
- Starts a weapon animation of type id
Name Type Description weaponImageIdnumber The weapon image id stateIcons()Arrayinherited
- Get state icons for states affecting the battler
Returns:
Type Description Array Array of state icon indexes stateMotionIndex()numberinherited
- Get the state motion index
Returns:
Type Description number The state motion index stateOverlayIndex()numberinherited
- Get the state overlay index
Returns:
Type Description number The state overlay index stateRate(stateId)numberinherited
- Get the state rate by id
Name Type Description stateIdnumber The id of the state Returns:
Type Description number The state rate stateResistSet()Arrayinherited
- Get the state resist trait set
Returns:
Type Description Array Array of state resist trait data ids states()Arrayinherited
- Get states affecting the battler
Returns:
Type Description Array Array of state data objects tpRate()numberinherited
- Get the battler's tp rate (tp / max tp)
Returns:
Type Description number The tp rate - Get the acceleration of the TPB
Returns:
Type Description number TPB acceleration - Get the base speed of the TPB
Returns:
Type Description number TPB base speed - Get the TPB charge time
Returns:
Type Description number The TPB charge time - Get the relative speed of the TPB
Returns:
Type Description number TPB relative speed - Get the cast time of the TPB
Returns:
Type Description number TPB cast time - Get the speed of the TPB
Returns:
Type Description number TPB speed traitObjects()Arrayinherited
- Get an array of all objects that have traits
Returns:
Type Description Array Array of all objects that have traits traits(code)Arrayinherited
- Get an array of all traits from all trait objects that match the given code
Name Type Description codenumber The trait code to check for Returns:
Type Description Array Array of traits with given code traitsPi(code, id)numberinherited
- Get multiplicative value of all traits with given code and id
Name Type Description codenumber The trait code idnumber The trait data id Returns:
Type Description number Value of the traits traitsSet(code)Arrayinherited
- Get array all trait data ids with given code
Name Type Description codenumber The trait code Returns:
Type Description Array Trait data ids traitsSum(code, id)numberinherited
- Get additive value of all traits with given code and id
Name Type Description codenumber The trait code idnumber The trait data id Returns:
Type Description number Value of the traits traitsSumAll(code)numberinherited
- Get additive value of all traits with given code
Name Type Description codenumber The trait code Returns:
Type Description number Value of the traits traitsWithId(code, id)Arrayinherited
- Get an array of all traits from all trait objects that match the given code and id
Name Type Description codenumber The trait code to check for idnumber The trait data id to check for Returns:
Type Description Array Array of traits with given code - Get the turn count
Returns:
Type Description number Turn count updateBuffTurns()inherited
- Update buff turn counts
updateStateTurns()inherited
- Update state turns
- Update for TPB
- Update TPB auto battle
- Update TPB cast time
- Update TPB charge time
- Update TPB idle time
- Use the given item
Name Type Description itemObject The item/skill object to use - Get the weapon image id
Returns:
Type Description number The weapon image id xparam(xparamId)numberinherited
- Get the x-parameter value by id
Name Type Description xparamIdnumber The id of the parameter Returns:
Type Description number The parameter value