The game object class for an actor.
Properties:
| Name | Type | Description |
|---|---|---|
level | number | The actor's level |
Extends
Methods
action(index)Game_Actioninherited
- 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 - Get the actor data object
Returns:
Type Description Object The actor data object - Get the actor's id
Returns:
Type Description number The actor's id addBuff(paramId, turns)inherited
- 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 addDebuff(paramId, turns)inherited
- 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 addState(stateId)inherited
- 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
applyTpbPenalty()inherited
- Applies a TPB penalty
- Get the actor's armors
Returns:
Type Description Array Array of equipped armors - Get the attack animation id1
Returns:
Type Description number The attack animation id1 - Get the attack animation id2
Returns:
Type Description number The attack animation id2 - 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 - Get the bare hand attack animation id
Returns:
Type Description number The bare hand attack animation id - Get the bare hand element id
Returns:
Type Description number The bare hand element id - Get basic damage for floor damage
Returns:
Type Description number Amount of basic damage for floor damage - Get the actor's battler name (for their battler image)
Returns:
Type Description string The actor's battler name - Rate modifier for exp gain for benched party members
Returns:
Type Description number The exp gain rate modifier - Get the best item for a given equip slot id
Name Type Description slotIdnumber The id of the equipment slot Returns:
Type Description Object The best item to equip in the given slot 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 - Calculate an item's performance
Name Type Description itemObject The item to calculate performance for Returns:
Type Description number The performance rating of the item 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 canInput()booleaninherited
- 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 cancelMotionRefresh()inherited
- Cancels a motion refresh
- Since:
- Version 1.1.0
- Changes the actor's class
Name Type Description classIdnumber The id of the class to change to keepExpboolean If the actor's exp in their previous class transfers to the new class - Changes the actor's equipment in the given slot to the given item
Name Type Description slotIdnumber The equipment slot id to change itemObject The data object to equip - Change equips by ids
Name Type Description etypeIdnumber The equipment type id itemIdnumber The id of the item to equip - Change the actor's exp
Name Type Description expnumber The new exp amount showboolean If level up messages show as a result of this operation - Changes the actor's level
Name Type Description levelnumber The actor's new level showboolean If level up messages display as a result of this operation - Get the actor's character index (on their character sheet)
Returns:
Type Description number The actor's character index - Get the actor's character name (for their character sheet)
Returns:
Type Description string The actor's character name chargeTpByDamage(damageRate)inherited
- Gains tp based on damage
Name Type Description damageRatenumber The damage rate to base tp gain off - Check if the player is on a floor effect
- Clears the battler's actions
clearBuffs()inherited
- Clear buffs
clearDamagePopup()inherited
- Clears the damage popup
clearEffect()inherited
- Clears an effect
- Clears all equipment slots
clearMotion()inherited
- Clears a motion
clearParamPlus()inherited
- Clears param bonus effects
clearResult()inherited
- Clears the result of an action
- Clears states affecting the battler
clearTp()inherited
- Clears tp
clearTpbChargeTime()inherited
- Clears TPB charge time
clearWeaponAnimation()inherited
- 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 consumeItem(item)inherited
- Consumes the given item
Name Type Description itemObject The item object to consume currentAction()Game_Actioninherited
- Get the current action
Returns:
Type Description Game_Action The current action - Get the class data object for the actor's current class
Returns:
Type Description Object The class data object - Get the actor's current exp
Returns:
Type Description number The actor's current exp - Get the exp needed for the actor's current level
Returns:
Type Description number The exp needed for the actor's current level 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 deselect()inherited
- Marks the battler as not selected
- Kills the battler
- Discards the item if it is equipped
Name Type Description itemObject The item to discard - Displays a level up message
Name Type Description newSkillsArray Skills the actor learned from leveling up effectType()stringinherited
- 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 - Get the actor's equip slots
Returns:
Type Description Array Array of equipment slots - Get the actor's equips
Returns:
Type Description Array Array of equipped items eraseBuff(paramId)inherited
- Erase a buff by param id
Name Type Description paramIdnumber The id of the param to erase buffs for - Erases a state by id
Name Type Description stateIdnumber The id of the state to erase escape()inherited
- Processing when there is an escape
- Executes a floor damage effect
- Get the exp needed for a given level
Name Type Description levelnumber The level to calculate exp for Returns:
Type Description number The exp needed - Get the actor's face index (on their face sheet)
Returns:
Type Description number The actor's face index - Get the actor's face name (for their face sheet)
Returns:
Type Description string The actor's face name - Rate at which exp is gained
Returns:
Type Description number The rate of exp gain - Gets the actor's new skills after change
Name Type Description lastSkillsArray Array of the actor's previous skills Returns:
Type Description Array Array of skills the actor knows but were not found in the lastSkills parameter finishTpbCharge()inherited
- Finishes the TPB charge
forceAction(skillId, targetIndex)inherited
- Force an action
Name Type Description skillIdnumber The skill id targetIndexnumber The target index - Forcibly changes the actor's equipment in the given slot to the given item
Name Type Description slotIdnumber The equipment slot id to change itemObject The data object to equip - Causes the actor to forget a skill by id
Name Type Description skillIdnumber The id of the skill to forget friendsUnit()Game_Party | Game_Troop
- Get the friendly unit in battle. For Game_Actor, this is Game_Party
Returns:
Type Description Game_Party|Game_Troop The friendly unit in battle - Gain exp
Name Type Description expnumber Amount of exp to gain gainHp(value)inherited
- Gains an amount of hp
Name Type Description valuenumber The amount of hp to gain gainMp(value)inherited
- Gains an amount of mp
Name Type Description valuenumber The amount of mp to gain gainSilentTp(value)inherited
- Gains an amount of tp without adding it to the action result
Name Type Description valuenumber The amount of tp to gain gainTp(value)inherited
- 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 - Check if the actor has the given armor
Name Type Description armorObject The armor data object Returns:
Type Description boolean True if the actor has the armor - Check if the actor has no weapon
Returns:
Type Description boolean True if the actor has no weapon - Check if the actor has already has a skill by id
Name Type Description skillIdnumber The id of the skill to check Returns:
Type Description boolean True if the actor already has the skill - Check if the actor has the given weapon
Name Type Description weaponObject The weapon data object Returns:
Type Description boolean True if the actor has the weapon - 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 - Get the actor's index in the party
Returns:
Type Description number The actor's index in the party - Initialize the actor's equipment
Name Type Description equipsArray Array of equipment ids for each equip slot - Initialize the actor's exp
- Initialize the actor's image data
- Initialize class variables
- Initialize the actor's skills
initTp()inherited
- Initialize tp
initTpbChargeTime(advantageous)inherited
- Initialize the TPB charge time
Name Type Description advantageousboolean If charge time should be advantageous initTpbTurn()inherited
- Initialize TPB turn
initialize(actorId)overrides
- Initialize the actor
Name Type Description actorIdnumber The actor's id inputtingAction()Game_Action
- Get inputting action
Returns:
Type Description Game_Action The inputting action isActing()booleaninherited
- Check if the action state is acting
Returns:
Type Description boolean True if acting isActor()booleanoverrides
- Check if this is an actor. When called from Game_Actor, this is always true
Returns:
Type Description boolean True if this is an 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 - Check if this actor will participate in battle
Returns:
Type Description boolean True if the actor will participate in 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 isChanting()booleaninherited
- Check if the battler is chanting
Returns:
Type Description boolean True if chanting - Check if the actor's class matches the given class
Name Type Description gameClassObject The class data object Returns:
Type Description boolean True if the given class is the actor's class isConfused()booleaninherited
- Check if the battler is confused
Returns:
Type Description boolean True if confused isDamagePopupRequested()booleaninherited
- 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 isEffectRequested()booleaninherited
- 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 - Check if the actor can change equips in the given slot
Name Type Description slotIdnumber The equipment slot id Returns:
Type Description boolean True if the actor can change the equip in the slot 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 - Check if the given item is equipped by the actor
Name Type Description itemObject The item to check for Returns:
Type Description boolean True if the item is already equipped - Check if this actor can change formation. When called from Game_Actor, this is always true
Returns:
Type Description boolean True if the actor can change formation isGuard()booleaninherited
- Check if the battler has the guard special flag
Returns:
Type Description boolean True if guard isGuardWaiting()booleaninherited
- 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 isInputting()booleaninherited
- Check if the action state is inputting
Returns:
Type Description boolean True if inputting - Check if the actor has already learned a skill by id
Name Type Description skillIdnumber The id of the skill to check Returns:
Type Description boolean True if the skill is already learned 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 the actor is max level
Returns:
Type Description boolean True if max level isMotionRefreshRequested()booleaninherited
- Check if a motion refresh is requested
Returns:
Type Description boolean True if a motion refresh has been requested isMotionRequested()booleaninherited
- 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 isSelected()booleaninherited
- 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(skill)booleanoverrides
- Check if actor has required weapon types for the given skill
Name Type Description skillObject The skill object Returns:
Type Description boolean True if the actor has the required weapon types equipped - Check if the battler sprite should be visible (for side view battles)
Returns:
Type Description boolean True if the battler sprite should be visible isStateAddable(stateId)booleaninherited
- 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 isStateRestrict(stateId)booleaninherited
- 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 isTpbCharged()booleaninherited
- Check if TPB is in the charged state
Returns:
Type Description boolean True if charged isTpbReady()booleaninherited
- Check if TPB is in the ready state
Returns:
Type Description boolean True if ready isTpbTimeout()booleaninherited
- Check if TPB is timed out
Returns:
Type Description boolean True if timed out isTpbTurnEnd()booleaninherited
- Check for turn end in TPB
Returns:
Type Description boolean True if turn ended isUndecided()booleaninherited
- Check if the action state is undecided
Returns:
Type Description boolean True if undecided isWaiting()booleaninherited
- Check if the action state is waiting
Returns:
Type Description boolean True if waiting isWeaponAnimationRequested()booleaninherited
- Check if a weapon animation is requested
Returns:
Type Description boolean True if a weapon animation has been requested - Check if actor has a weapon of the given type equipped
Name Type Description wtypeIdnumber The weapon type id to check for Returns:
Type Description boolean True if the actor has a weapon of the given type equipped - Get the last skill from battle
Returns:
Type Description Object Last skill object - Get the last command symbol
Returns:
Type Description string The last command symbol - Get the last skill from menu
Returns:
Type Description Object Last skill object - Get the last skill
Returns:
Type Description Object Last skill object - Causes the actor to learn a skill by id
Name Type Description skillIdnumber The id of the skill to learn - Handles when the actor levels down
- Handles when the actor levels up
- Make the action list
Returns:
Type Description Array A list of actions makeActionTimes()numberinherited
- Make the action times
Returns:
Type Description number The action times - Make the battler's actions
- Make the auto battle action
- Make actions when confused
makeSpeed()inherited
- Make the battler's speed
makeTpbActions()inherited
- Makes the TPB actions
- Get maximum amount of floor damage to inflict
Returns:
Type Description number Maximum amount of floor damage the player can take - Get the actor's max level
Returns:
Type Description number The actor's max level maxSlipDamage()numberinherited
- 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 - 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 motionType()stringinherited
- 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 actor's name
Returns:
Type Description string The actor's name - Get the exp needed for the actor's next level
Returns:
Type Description number The exp needed for the actor's next level - Get the exp needed to level up from the actor's current exp
Returns:
Type Description number The exp needed to level up - Get the actor's nickname
Returns:
Type Description string The actor's nickname numActions()numberinherited
- Get the amount of actions the battler has
Returns:
Type Description number Amount of actions onAllActionsEnd()inherited
- Processing when all actions are over
onBattleEnd()inherited
- Processing when a battle ends
onBattleStart(advantageous)inherited
- Processing when a battle starts
Name Type Description advantageousboolean If the battle is advantageous onDamage(value)inherited
- Processing when damage occurs
Name Type Description valuenumber Amount of damage taken - Handling when an escape fails
- Processing when the player walks on the map
onRestrict()inherited
- Processing when a restriction is added
onTpbCharged()inherited
- Processing when TPB is charged
onTpbTimeout()inherited
- Processing for when TPB is timed out
onTurnEnd()inherited
- Processing when a turn ends
opponentsUnit()Game_Party | Game_Troop
- Get the enemy unit in battle. For Game_Actor, this is Game_Troop
Returns:
Type Description Game_Party|Game_Troop The enemy unit in battle - Optimizes equipment
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(paramId)numberoverrides
- Get a base param value
Name Type Description paramIdnumber The id of the param to get Returns:
Type Description number The base param value 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 - 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 - Performs an attack
- 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 escape
- Perform an evasion
- Perform a magic evasion
- Perform damage on map
performMiss()inherited
- Perform a miss
performRecovery()inherited
- Perform a recovery
performReflection()inherited
- Perform a reflection
performSubstitute()inherited
- Perform a substitute. When called from Game_Battler, this does nothing.
- Perform a victory
- Get the actor's profile
Returns:
Type Description string The actor's profile recoverAll()inherited
- Recover all for the battler
- Refresh the battler
regenerateAll()inherited
- Regenerates everything (hp/mp/tp)
regenerateHp()inherited
- Regenerates hp
regenerateMp()inherited
- Regenerates mp
regenerateTp()inherited
- Regenerates tp
- Unequips items that are not equippable
Name Type Description forcingboolean If uneqippping items forcibly removeAllBuffs()inherited
- Remove all buffs
removeBattleStates()inherited
- Remove states that end after battle
removeBuff(paramId)inherited
- Remove a buff to the battler by id
Name Type Description paramIdnumber Id of the param to remove buffs for removeBuffsAuto()inherited
- Remove buffs when they expire
removeCurrentAction()inherited
- Removes the current action
removeState(stateId)inherited
- Remove a state to the battler by id
Name Type Description stateIdnumber Id of state to be removed removeStatesAuto(timing)inherited
- Remove states set to auto remove
Name Type Description timingnumber The timing to check against for auto removal removeStatesByDamage()inherited
- Remove states that are removed by damage
requestEffect(effectType)inherited
- Requests an effect
Name Type Description effectTypestring The type of effect to request requestMotion(motionType)inherited
- Requests a motion
Name Type Description motionTypestring The type of motion to request requestMotionRefresh()inherited
- Requests a motion refresh
- 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
select()inherited
- Marks the battler as selected
- Selects the next command
Returns:
Type Description boolean True if selected - Selects the previous command
Returns:
Type Description boolean True if selected setAction(index, action)inherited
- Set an action at the given index
Name Type Description indexnumber The index to set the action of actionGame_Action The action to set setActionState(actionState)inherited
- Set the action state
Name Type Description actionStatestring The new action state - Changes the actor's battler image
Name Type Description battlerNamestring Name of the battler image - Changes the actor's character image
Name Type Description characterNamestring Name of the character sheet characterIndexnumber Index on the character sheet - Changes the actor's face image
Name Type Description faceNamestring Name of the face sheet faceIndexnumber Index on the face sheet setHp(hp)inherited
- Sets the battler's hp to the given value
Name Type Description hpnumber The new hp value - Set the last skill from battle
Name Type Description skillObject The skill object - Set the last command symbol
Name Type Description symbolstring The command symbol - Set the last skill from menu
Name Type Description skillObject The skill object setLastTarget(target)inherited
- 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 - Set the actor's name
Name Type Description namestring The actor's new name - Set the actor's nickname
Name Type Description nicknamestring The actor's new nickname - Set the actor's profile
Name Type Description profilestring The actor's new profile setTp(tp)inherited
- Sets the battler's tp to the given value
Name Type Description tpnumber The new tp value - Set up the actor
Name Type Description actorIdnumber The actor's id shouldDelayTpbCharge()booleaninherited
- Check if charging should be delayed
Returns:
Type Description boolean True if delay is needed - Check if level up messages should display. For Game_Actor, this always returns true
Returns:
Type Description boolean True if level up messages should display shouldPopupDamage()booleaninherited
- Check if a damage popup should appear
Returns:
Type Description boolean True if should popup damage - Displays a message when state is added
- Displays a message when state is removed
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 - Get the actor's skill types
Returns:
Type Description Array The actor's skill types - Get the actor's skills
Returns:
Type Description Array The actor's skills 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 speed()numberinherited
- Get the battler's speed
Returns:
Type Description number The battler's speed startDamagePopup()inherited
- Starts the damage popup
startTpbAction()inherited
- Starts a TPB action
startTpbCasting()inherited
- Starts TPB casting
startTpbTurn()inherited
- Starts TPB turn
startWeaponAnimation(weaponImageId)inherited
- 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 - Get the steps per turn
Returns:
Type Description number Steps per turn - Check if the given item has an escape effect
Name Type Description itemObject The item object to test Returns:
Type Description boolean True if escape special effect detected tpRate()numberinherited
- Get the battler's tp rate (tp / max tp)
Returns:
Type Description number The tp rate tpbAcceleration()numberinherited
- Get the acceleration of the TPB
Returns:
Type Description number TPB acceleration tpbBaseSpeed()numberinherited
- Get the base speed of the TPB
Returns:
Type Description number TPB base speed tpbChargeTime()numberinherited
- Get the TPB charge time
Returns:
Type Description number The TPB charge time tpbRelativeSpeed()numberinherited
- Get the relative speed of the TPB
Returns:
Type Description number TPB relative speed tpbRequiredCastTime()numberinherited
- Get the cast time of the TPB
Returns:
Type Description number TPB cast time tpbSpeed()numberinherited
- Get the speed of the TPB
Returns:
Type Description number TPB speed - Trades an item the actor has with the party inventory
Name Type Description newItemObject The item to trade to the actor oldItemObject The item to trade to the party inventory Returns:
Type Description boolean True if the trade succeeds - 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 turnCount()numberinherited
- Get the turn count
Returns:
Type Description number Turn count - Handle a turn end on map scene
updateBuffTurns()inherited
- Update buff turn counts
- Update states that can end by walking
Name Type Description stateObject The state object to update updateStateTurns()inherited
- Update state turns
updateTpb()inherited
- Update for TPB
updateTpbAutoBattle()inherited
- Update TPB auto battle
updateTpbCastTime()inherited
- Update TPB cast time
updateTpbChargeTime()inherited
- Update TPB charge time
updateTpbIdleTime()inherited
- Update TPB idle time
- Get the actor's usable skills
Returns:
Type Description Array The actor's usable skills useItem(item)inherited
- Use the given item
Name Type Description itemObject The item/skill object to use weaponImageId()numberinherited
- Get the weapon image id
Returns:
Type Description number The weapon image id - Get the actor's weapons
Returns:
Type Description Array Array of equipped weapons 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