Class: Game_Actor

Game_Actor()

new Game_Actor()

The game object class for an actor.
Properties:
Name Type Description
level Number [read-only] Level

Extends

Methods

action(index) → {Game_Action}

Parameters:
Name Type Description
index Number
Inherited From:
Returns:
Type
Game_Action

actionPlusSet() → {Array.<number>}

Inherited From:
Returns:
Type
Array.<number>

actor() → {RPG.Actor}

Returns the database information of the actor.
Returns:
Type
RPG.Actor

actorId() → {Number}

Returns the id of the actor.
Returns:
Type
Number

addBuff(paramId, turns)

Adds a buff to the battler for the specified number of turns on the selected parameter.
Parameters:
Name Type Description
paramId Number
turns Number
Inherited From:

addDebuff(paramId, turns)

Adds a debuff to the battler for the specified number of turns on the selected parameter.
Parameters:
Name Type Description
paramId Number
turns Number
Inherited From:

addedSkills() → {Array.<number>}

Inherited From:
Returns:
Type
Array.<number>

addedSkillTypes() → {Array.<number>}

Inherited From:
Returns:
Type
Array.<number>

addNewState(stateId)

Adds a new state given a state id to the battler.
Parameters:
Name Type Description
stateId Number
Inherited From:

addParam(paramId, value)

Parameters:
Name Type Description
paramId Number
value Number
Inherited From:

addState(stateId)

Adds a state to the battler given the specified state id.
Parameters:
Name Type Description
stateId Number
Inherited From:

allIcons() → {Array.<number>}

Returns all of the icons attached to the battler.
Inherited From:
Returns:
Type
Array.<number>

allTraits() → {Array.<RPG.Trait>}

Returns all the traits of the battler.
Inherited From:
Returns:
Type
Array.<RPG.Trait>

appear()

Shows the game battler.
Inherited From:

armors() → {Array.<RPG.Armor>}

Returns the armor of the actor.
Returns:
Type
Array.<RPG.Armor>

attackAnimationId1() → {Number}

Returns the first attack animation id.
Returns:
Type
Number

attackAnimationId2() → {Number}

Returns the second attack animation id.
Returns:
Type
Number

attackElements() → {Array.<Number>}

Returns the attack element ids.
Overrides:
Returns:
Type
Array.<Number>

attackSkillId() → {Number}

Returns the attack skill id in the database.
Inherited From:
Returns:
Type
Number

attackSpeed() → {Number}

Returns the attack speed of the battler.
Inherited From:
Returns:
Type
Number

attackStates() → {Array.<number>}

Returns the attack states of the battler as a list of numbers.
Inherited From:
Returns:
Type
Array.<number>

attackStatesRate(stateId)

Parameters:
Name Type Description
stateId Number
Inherited From:

attackTimesAdd() → {Number}

Returns the number of attacks available to the battler.
Inherited From:
Returns:
Type
Number

bareHandsAnimationId() → {Number}

Returns the animation id for a barehanded attack.
Returns:
Type
Number

bareHandsElementId() → {Number}

Returns the element id of barehanded attacks.
Returns:
Type
Number

basicFloorDamage() → {Number}

Returns the basic floor damage.
Returns:
Type
Number

battlerName() → {String}

Returns:
Type
String

benchMembersExpRate() → {Number}

Returns the exp rate of actors not in battle; this is set in the database.
Returns:
Type
Number

bestEquipItem(slotId)

Equips the best item in the given slot.
Parameters:
Name Type Description
slotId Number

buff(paramId) → {Number}

Buffs the current parameter id.
Parameters:
Name Type Description
paramId Number
Inherited From:
Returns:
Type
Number

buffIconIndex(buffLevel, paramId) → {Number}

Parameters:
Name Type Description
buffLevel Number
paramId Number
Inherited From:
Returns:
Type
Number

buffIcons() → {Array.<number>}

Returns the array of buff icons attached to the battler; this is determined by the active buffs on the battler.
Inherited From:
Returns:
Type
Array.<number>

buffLength() → {Number}

Returns the length of the buff.
Inherited From:
Returns:
Type
Number

calcEquipItemPerformance(item) → {Number}

Calculates the equip item performance and returns the sum/difference.
Parameters:
Name Type Description
item RPG.EquipItem
Returns:
Type
Number

canAttack() → {Boolean}

Returns true if the battler can attack.
Inherited From:
Returns:
Type
Boolean

canEquip(item) → {Boolean}

Returns true if the battler can equip the item.
Parameters:
Name Type Description
item RPG.EquipItem
Inherited From:
Returns:
Type
Boolean

canEquipArmor(item) → {Boolean}

Returns true if the battler can equip armor.
Parameters:
Name Type Description
item RPG.EquipItem
Inherited From:
Returns:
Type
Boolean

canEquipWeapon(item) → {Boolean}

Returns true if the battler can equip a weapon.
Parameters:
Name Type Description
item RPG.EquipItem
Inherited From:
Returns:
Type
Boolean

canGuard() → {Boolean}

Returns true if the battler can guard.
Inherited From:
Returns:
Type
Boolean

canInput() → {Boolean}

Returns true if the battler can input actions.
Inherited From:
Returns:
Type
Boolean

canMove() → {Boolean}

Inherited From:
Returns:
Type
Boolean

canPaySkillCost(skill) → {Boolean}

Returns true if the battler can pay the cost of the specified skill.
Parameters:
Name Type Description
skill RPG.Skill
Inherited From:
Returns:
Type
Boolean

canUse(item) → {Boolean}

Returns true if the battler can use the item.
Parameters:
Name Type Description
item RPG.UsableItem
Inherited From:
Returns:
Type
Boolean

changeClass(classId, keepExp)

Changes the actor class; if keep is true, the actor will retain their experience points.
Parameters:
Name Type Description
classId Number
keepExp Boolean

changeEquip(slotId, item)

Changes the actor equipment in the given slot with the given equip item. Places the original item into the party inventory.
Parameters:
Name Type Description
slotId Number
item RPG.EquipItem

changeEquipById(etypeId, itemId)

Changes the actor equip with an item based on the equip id.
Parameters:
Name Type Description
etypeId Number
itemId Number

changeExp(exp, show)

Change the actor experience points; leveling up the actor if it's above the required exp for the current level. If show is set to true, actor level up with be displayed.
Parameters:
Name Type Description
exp Number
show Boolean

changeLevel(level, show)

Changes the actor level; if show is set to true, the actor level will be displayed.
Parameters:
Name Type Description
level Number
show Boolean

characterIndex() → {Number}

Returns:
Type
Number

characterName() → {String}

Returns:
Type
String

chargeTpByDamage(damageRate)

Parameters:
Name Type Description
damageRate Number
Inherited From:

checkFloorEffect()

Checks the effect of the floor on the actor.

clearActions()

Clears all of the actor's animations.
Overrides:

clearAnimations()

Clears animations from the battler.
Inherited From:

clearBuffs()

Clears buffs from the battler.
Inherited From:

clearDamagePopup()

Clear damage pop up from the battler.
Inherited From:

clearEffect()

Clears effect from the battler.
Inherited From:

clearEquipments()

Clears the actor's equipment; items are returned to the inventory.

clearMotion()

Clears motion from the battler.
Inherited From:

clearParamPlus()

Inherited From:

clearResult()

Clears the battler action result.
Inherited From:

clearStates()

Clears all states from the actor.
Overrides:

clearTp()

Clears the battler's tp.
Inherited From:

clearWeaponAnimation()

Clear weapon animation from the battler.
Inherited From:

collapseType() → {Number}

Returns the collapse type of the battler.
Inherited From:
Returns:
Type
Number

confusionLevel() → {Number}

Returns the confusion level of the battler.
Inherited From:
Returns:
Type
Number

consumeItem(item)

Has the battler consume the given item.
Parameters:
Name Type Description
item RPG.UsableItem
Inherited From:

currentAction() → {Game_Action}

Returns the current action of the battler.
Inherited From:
Returns:
Type
Game_Action

currentClass() → {RPG.Class}

Returns the current class of the actor from the database.
Returns:
Type
RPG.Class

currentExp() → {Number}

Returns the current experience points of the actor.
Returns:
Type
Number

currentLevelExp() → {Number}

Returns the current level's experience for the actor.
Returns:
Type
Number

deathStateId() → {Number}

Returns the death state id.
Inherited From:
Returns:
Type
Number

debuffRate(paramId) → {Number}

Parameters:
Name Type Description
paramId Number
Inherited From:
Returns:
Type
Number

decreaseBuff(paramId)

Parameters:
Name Type Description
paramId Number
Inherited From:

deselect()

Inherited From:

die()

Kills the battler.
Inherited From:

discardEquip(item)

Discards the given equip item from the actor; item is not return to the party inventory.
Parameters:
Name Type Description
item RPG.EquipItem

displayLevelUp(newSkills)

Displays the actor level up in a message window, with the learned skills.
Parameters:
Name Type Description
newSkills Array.<RPG.Skill>

effectType() → {String}

Returns the effect type of the battler.
Inherited From:
Returns:
Type
String

elementRate(elementId) → {Number}

Parameters:
Name Type Description
elementId Number
Inherited From:
Returns:
Type
Number

equips() → {Array.<RPG.EquipItem>}

Returns the equipment of the actor.
Returns:
Type
Array.<RPG.EquipItem>

equipSlots() → {Array.<Number>}

Returns the equip slots of the actor.
Returns:
Type
Array.<Number>

eraseBuff(paramId)

Parameters:
Name Type Description
paramId Number
Inherited From:

eraseState(stateId)

Erase the specified state from the actor.
Parameters:
Name Type Description
stateId Number
Overrides:

escape()

Has the battler escape from battle; plays a sound on escaping.
Inherited From:

executeFloorDamage()

Executes the floor dmaage on the actor.

expForLevel(level) → {Number}

Returns the exp required to level.
Parameters:
Name Type Description
level Number
Returns:
Type
Number

faceIndex() → {Number}

Returns the face index of the actor.
Returns:
Type
Number

faceName() → {String}

Returns the face name of the actor; this is the image of faces for the actor.
Returns:
Type
String

finalExpRate() → {Number}

Returns the final exp rate of the actor based on if the actor is a reserved party member or an active battle member.
Returns:
Type
Number

findNewSkills(lastSkills) → {Array.<RPG.Skill>}

Parameters:
Name Type Description
lastSkills Array.<RPG.Skill>
Returns:
Type
Array.<RPG.Skill>

forceAction(skillId, targetIndex)

Parameters:
Name Type Description
skillId Number
targetIndex Number
Inherited From:

forceChangeEquip(slotId, item)

Forces the actor to change equipment in the given slot with the given equip item without placing the item back into the party inventory.
Parameters:
Name Type Description
slotId Number
item RPG.EquipItem

forgetSkill(skillId)

Actor forgets the specified skill given the skill id from the actor's usable skills.
Parameters:
Name Type Description
skillId Number

friendsUnit() → {Game_Party}

Returns:
Type
Game_Party

gainExp(exp)

Gives the specified exp to the actor.
Parameters:
Name Type Description
exp Number

gainHp(value)

Adds the specified amount of hp to the battler.
Parameters:
Name Type Description
value Number
Inherited From:

gainMp(value)

Adds the specified amount of mp to the battler.
Parameters:
Name Type Description
value Number
Inherited From:

gainSilentTp(value)

Adds a specified amount of tp to the battler silently.
Parameters:
Name Type Description
value Number
Inherited From:

gainTp(value)

Adds the specified amount of tp to the battler.
Parameters:
Name Type Description
value Number
Inherited From:

guardSkillId() → {Number}

Returns the guard skill id in the database.
Inherited From:
Returns:
Type
Number

hasArmor(armor) → {Boolean}

Returns true if the actor has armor.
Parameters:
Name Type Description
armor RPG.Armor
Returns:
Type
Boolean

hasNoWeapons() → {Boolean}

Returns true if the actor has no weapon.
Returns:
Type
Boolean

hasSkill(skillId) → {Boolean}

Parameters:
Name Type Description
skillId Number
Returns:
Type
Boolean

hasWeapon(weapon) → {Boolean}

Returns true if the actor has a weapon.
Parameters:
Name Type Description
weapon RPG.Weapon
Returns:
Type
Boolean

hide()

Hides the game battler.
Inherited From:

hpRate() → {Number}

Returns the percentage of the battler's hp left as a float.
Inherited From:
Returns:
Type
Number

increaseBuff(paramId)

Parameters:
Name Type Description
paramId Number
Inherited From:

index() → {Number}

Returns:
Type
Number

initEquips(equips)

Initialize actor equipment in the given slots.
Parameters:
Name Type Description
equips Array.<Number>

initExp()

Initialize exp of the actor.

initialize(actorId)

Parameters:
Name Type Description
actorId Number
Overrides:

initImages()

Initialize images of the actor.

initMembers()

Overrides:

initSkills()

Initialize actor skills.

initTp()

Initializes the battler's tp; tp is random.
Inherited From:

inputtingAction() → {Game_Action}

Returns action the actor is inputting.
Returns:
Type
Game_Action

isActing() → {Boolean}

Returns true if the battler is performing an action in battle.
Inherited From:
Returns:
Type
Boolean

isActor() → {Boolean}

Overrides:
Returns:
Type
Boolean

isAlive() → {Boolean}

Returns true if the battler is alive.
Inherited From:
Returns:
Type
Boolean

isAnimationRequested() → {Boolean}

Inherited From:
Returns:
Type
Boolean

isAppeared() → {Boolean}

Returns true if the game battler is not hidden.
Inherited From:
Returns:
Type
Boolean

isAutoBattle() → {Boolean}

Returns true if the battler is set to battle automatically.
Inherited From:
Returns:
Type
Boolean

isBattleMember() → {Boolean}

Returns true if the actor is a member in battle.
Returns:
Type
Boolean

isBuffAffected(paramId) → {Boolean}

Parameters:
Name Type Description
paramId Number
Inherited From:
Returns:
Type
Boolean

isBuffExpired(paramId) → {Boolean}

Parameters:
Name Type Description
paramId Number
Inherited From:
Returns:
Type
Boolean

isBuffOrDebuffAffected(paramId) → {Boolean}

Parameters:
Name Type Description
paramId Number
Inherited From:
Returns:
Type
Boolean

isChanting() → {Boolean}

Returns true if the battler is chanting in combat.
Inherited From:
Returns:
Type
Boolean

isClass(gameClass) → {Boolean}

Returns true if the actor is the specified class from the database.
Parameters:
Name Type Description
gameClass RPG.Class
Returns:
Type
Boolean

isConfused() → {Boolean}

Returns true if the battler is confused.
Inherited From:
Returns:
Type
Boolean

isDamagePopupRequested() → {Boolean}

Inherited From:
Returns:
Type
Boolean

isDead() → {Boolean}

Returns true if the battler is dead.
Inherited From:
Returns:
Type
Boolean

isDeathStateAffected() → {Boolean}

Inherited From:
Returns:
Type
Boolean

isDebuffAffected(paramId) → {Boolean}

Parameters:
Name Type Description
paramId Number
Inherited From:
Returns:
Type
Boolean

isDualWield() → {Boolean}

Returns true if the battler dual wields.
Inherited From:
Returns:
Type
Boolean

isDying() → {Boolean}

Returns true if the battler is dying.
Inherited From:
Returns:
Type
Boolean

isEffectRequested() → {Boolean}

Inherited From:
Returns:
Type
Boolean

isEnemy() → {Boolean}

Returns true if the battler is an enemy.
Inherited From:
Returns:
Type
Boolean

isEquipAtypeOk(atypeId) → {Boolean}

Parameters:
Name Type Description
atypeId Number
Inherited From:
Returns:
Type
Boolean

isEquipChangeOk(slotId) → {Boolean}

Returns true if the equip change is okay in the given slot.
Parameters:
Name Type Description
slotId Number
Returns:
Type
Boolean

isEquipped(item) → {Boolean}

Returns true if the actor is equipped with the specific item.
Parameters:
Name Type Description
item RPG.EquipItem
Returns:
Type
Boolean

isEquipTypeLocked(etypeId) → {Boolean}

Parameters:
Name Type Description
etypeId Number
Inherited From:
Returns:
Type
Boolean

isEquipTypeSealed(etypeId) → {Boolean}

Parameters:
Name Type Description
etypeId Number
Inherited From:
Returns:
Type
Boolean

isEquipWtypeOk(wtypeId) → {Boolean}

Parameters:
Name Type Description
wtypeId Number
Inherited From:
Returns:
Type
Boolean

isFormationChangeOk() → {Boolean}

Returns:
Type
Boolean

isGuard() → {Boolean}

Returns true if the battler is guarding.
Inherited From:
Returns:
Type
Boolean

isGuardWaiting() → {Boolean}

Returns true if the battler is waiting to guard.
Inherited From:
Returns:
Type
Boolean

isHidden() → {Boolean}

Returns true if the game battler is hidden.
Inherited From:
Returns:
Type
Boolean

isInputting() → {Boolean}

Returns true if the battler is inputting commands in battle.
Inherited From:
Returns:
Type
Boolean

isLearnedSkill(skillId) → {Boolean}

Returns true if the actor has learned the specified skill given the specified skill id.
Parameters:
Name Type Description
skillId Number
Returns:
Type
Boolean

isMaxBuffAffected(paramId) → {Boolean}

Parameters:
Name Type Description
paramId Number
Inherited From:
Returns:
Type
Boolean

isMaxDebuffAffected(paramId) → {Boolean}

Parameters:
Name Type Description
paramId Number
Inherited From:
Returns:
Type
Boolean

isMaxLevel() → {Boolean}

Returns true if the actor is max level.
Returns:
Type
Boolean

isMotionRefreshRequested() → {Boolean}

Inherited From:
Returns:
Type
Boolean

isMotionRequested() → {Boolean}

Returns true if a motion is requested.
Inherited From:
Returns:
Type
Boolean

isOccasionOk(item) → {Boolean}

Returns true if the item occasion is okay.
Parameters:
Name Type Description
item RPG.UsableItem
Inherited From:
Returns:
Type
Boolean

isPreserveTp() → {Boolean}

Returns true if tp is preserved between battles.
Inherited From:
Returns:
Type
Boolean

isRestricted() → {Boolean}

Returns true if the game battler is restricted.
Inherited From:
Returns:
Type
Boolean

isSelected() → {Boolean}

Inherited From:
Returns:
Type
Boolean

isSkillSealed(stypeId) → {Boolean}

Parameters:
Name Type Description
stypeId Number
Inherited From:
Returns:
Type
Boolean

isSkillTypeSealed(stypeId) → {Boolean}

Parameters:
Name Type Description
stypeId Number
Inherited From:
Returns:
Type
Boolean

isSkillWtypeOk(skill) → {Boolean}

Parameters:
Name Type Description
skill RPG.Skill
Overrides:
Returns:
Type
Boolean

isSpriteVisible() → {Boolean}

Returns true if the actor sprite is visible.
Returns:
Type
Boolean

isStateAddable(stateId) → {Boolean}

Returns true if the specified state given the state id is addable.
Parameters:
Name Type Description
stateId Number
Inherited From:
Returns:
Type
Boolean

isStateAffected(stateId) → {Boolean}

Returns true if the battler is affected by the specified state given the state id.
Parameters:
Name Type Description
stateId Number
Inherited From:
Returns:
Type
Boolean

isStateExpired(stateId) → {Boolean}

Returns true if the state, given the state id is expired.
Parameters:
Name Type Description
stateId Number
Inherited From:
Returns:
Type
Boolean

isStateResist(stateId) → {Boolean}

Parameters:
Name Type Description
stateId Number
Inherited From:
Returns:
Type
Boolean

isStateRestrict(stateId) → {Boolean}

Returns true if the specified state given the state id restricts.
Parameters:
Name Type Description
stateId Number
Inherited From:
Returns:
Type
Boolean

isSubstitute() → {Boolean}

Inherited From:
Returns:
Type
Boolean

isUndecided() → {Boolean}

Inherited From:
Returns:
Type
Boolean

isWaiting() → {Boolean}

Returns true if the battler is waiting in battle.
Inherited From:
Returns:
Type
Boolean

isWeaponAnimationRequested() → {Boolean}

Returns true if a weapon animation is requested.
Inherited From:
Returns:
Type
Boolean

isWtypeEquipped(wtypeId) → {Boolean}

Parameters:
Name Type Description
wtypeId Number
Returns:
Type
Boolean

lastBattleSkill() → {RPG.Skill}

Returns the last battle skill of the actor.
Returns:
Type
RPG.Skill

lastCommandSymbol() → {String}

Returns the last command symbol that the actor used.
Returns:
Type
String

lastMenuSkill() → {RPG.Skill}

Returns the last menu skill of the actor.
Returns:
Type
RPG.Skill

learnSkill(skillId)

Actor learns the specified skill given the skill id.
Parameters:
Name Type Description
skillId Number

levelDown()

Level down the actor.

levelUp()

Level up the actor.

makeActionList() → {Array.<Game_Action>}

Creates the action list for the actor.
Returns:
Type
Array.<Game_Action>

makeActions()

Overrides:

makeActionTimes() → {Number}

Creates the number of times for an action.
Inherited From:
Returns:
Type
Number

makeAutoBattleActions()

Creates the auto battle actions for the game actor.

makeConfusionActions()

makeSpeed()

Calculates the speed of the battler.
Inherited From:

maxFloorDamage() → {Number}

Returns the max floor damage.
Returns:
Type
Number

maxLevel()

Returns the maximum level of the actor.

maxSlipDamage() → {Number}

Inherited From:
Returns:
Type
Number

maxTp() → {Number}

Returns the maximum tp of the battler.
Inherited From:
Returns:
Type
Number

meetsItemConditions(item) → {Boolean}

Returns true if the battler meets the item conditions.
Parameters:
Name Type Description
item RPG.Item
Inherited From:
Returns:
Type
Boolean

meetsSkillConditions(skill) → {Boolean}

Returns true if the battler meets the skill conditions.
Parameters:
Name Type Description
skill RPG.Skill
Inherited From:
Returns:
Type
Boolean

meetsUsableItemConditions(item) → {Boolean}

Parameters:
Name Type Description
item RPG.UsableItem
Overrides:
Returns:
Type
Boolean

mostImportantStateText() → {String}

Inherited From:
Returns:
Type
String

motionType() → {String}

Returns the motion type of the battler.
Inherited From:
Returns:
Type
String

mpRate() → {Number}

Returns the percentage of the battler's mp left as a float.
Inherited From:
Returns:
Type
Number

name(name)

Sets the actor name.
Parameters:
Name Type Description
name String

nextLevelExp() → {Number}

Returns the experience points for the next level of the actor.
Returns:
Type
Number

nextRequiredExp() → {Number}

Returns the next required experience points for the actor to level up.
Returns:
Type
Number

nickname() → {String}

Returns the nickname of the actor.
Returns:
Type
String

numActions() → {Number}

Returns the number of battler actions.
Inherited From:
Returns:
Type
Number

onAllActionsEnd()

Inherited From:

onBattleEnd()

Inherited From:

onBattleStart()

Inherited From:

onDamage(value)

Parameters:
Name Type Description
value Number
Inherited From:

onPlayerWalk()

Handler for when the player walks on the map scene.

onRestrict()

Handler for when theb attler is restricted.
Inherited From:

onTurnEnd()

Inherited From:

opponentsUnit() → {Game_Troop}

Returns:
Type
Game_Troop

optimizeEquipments()

Optimize the actor's equipment.

overwriteBuffTurns(paramId, turns)

Parameters:
Name Type Description
paramId Number
turns Number
Inherited From:

param(paramId) → {Number}

Returns a standard parameter, given a paramId; standard parameters include: HP, MP, Atk, M.Atk, Def, M.Def, Luck, Agility.
Parameters:
Name Type Description
paramId Number
Inherited From:
Returns:
Type
Number

paramBase(paramId) → {Number}

Parameters:
Name Type Description
paramId Number
Overrides:
Returns:
Type
Number

paramBuffRate(paramId) → {Number}

Parameters:
Name Type Description
paramId Number
Inherited From:
Returns:
Type
Number

paramMax(paramId) → {Number}

Parameters:
Name Type Description
paramId Number
Overrides:
Returns:
Type
Number

paramMin(paramId) → {Number}

Parameters:
Name Type Description
paramId Number
Inherited From:
Returns:
Type
Number

paramPlus(paramId) → {Number}

Parameters:
Name Type Description
paramId Number
Overrides:
Returns:
Type
Number

paramRate(paramId) → {Number}

Parameters:
Name Type Description
paramId Number
Inherited From:
Returns:
Type
Number

partyAbility(abilityId) → {Boolean}

Parameters:
Name Type Description
abilityId Number
Inherited From:
Returns:
Type
Boolean

paySkillCost(skill)

Pays the cost of the skill when activating the skill.
Parameters:
Name Type Description
skill RPG.Skill
Inherited From:

performAction(action)

Parameters:
Name Type Description
action Game_Action
Overrides:

performActionEnd()

Overrides:

performActionStart(action)

Parameters:
Name Type Description
action Game_Action
Overrides:

performAttack()

Performs the attack motion for the actor.

performCollapse()

Overrides:

performCounter()

Overrides:

performDamage()

Overrides:

performEscape()

Performs the escape motion for the actor.

performEvasion()

Overrides:

performMagicEvasion()

Overrides:

performMapDamage()

Perform damage to the actor on the map scene.

performMiss()

Perform miss motion.
Inherited From:

performRecovery()

Perform recovery motion.
Inherited From:

performReflection()

Performs the reflect motion.
Inherited From:

performSubstitute(target)

Perform substitute motion with the specified game battler.
Parameters:
Name Type Description
target Game_Battler
Inherited From:

performVictory()

Perform the victory motion for the actor.

profile() → {String}

Returns the actor profile.
Returns:
Type
String

recoverAll()

Recovers the battler from all states and restores the battler to maximum hp and mp.
Inherited From:

refresh()

Refreshes the actor.
Overrides:

regenerateAll()

Handler for when battle has started.
Inherited From:

regenerateHp()

Has the battler regenerate hp based on their hp regen.
Inherited From:

regenerateMp()

Has the battler regenerate mp based on their mp regen.
Inherited From:

regenerateTp()

Has the battler regenerate tp based on their tp regen.
Inherited From:

releaseUnequippableItems(forcing)

Returns items the actor can't normally equip to the party inventory.
Parameters:
Name Type Description
forcing Boolean

removeAllBuffs()

Removes all buffs from the battler.
Inherited From:

removeBattleStates()

Inherited From:

removeBuff(paramId)

Parameters:
Name Type Description
paramId Number
Inherited From:

removeBuffsAuto()

Inherited From:

removeCurrentAction()

Removes the current battler action.
Inherited From:

removeState(stateId)

Removes the specified state given the state id.
Parameters:
Name Type Description
stateId Number
Inherited From:

removeStatesAuto(timing)

Parameters:
Name Type Description
timing Number
Inherited From:

removeStatesByDamage()

Inherited From:

requestEffect(effectType)

Parameters:
Name Type Description
effectType String
Inherited From:

requestMotion(motionType)

Request the specified motion on the game battler.
Parameters:
Name Type Description
motionType String
Inherited From:

requestMotionRefresh()

Inherited From:

resetStateCounts(stateId)

Reset state count of the specified state.
Parameters:
Name Type Description
stateId Number
Overrides:

restriction() → {Number}

Returns the number of the restriction.
Inherited From:
Returns:
Type
Number

result() → {Game_ActionResult}

Returns the battler action result.
Inherited From:
Returns:
Type
Game_ActionResult

revive()

Revives the battler.
Inherited From:

select()

Inherited From:

selectNextCommand() → {Boolean}

Returns:
Type
Boolean

selectPreviousCommand() → {Boolean}

Returns:
Type
Boolean

setAction(index, action)

Sets the action at the specified index for the battler.
Parameters:
Name Type Description
index Number
action Game_Action
Inherited From:

setActionState(actionState)

Parameters:
Name Type Description
actionState String
Inherited From:

setBattlerImage(battlerName)

Sets the battler image of the actor; this is the sprite displayed in the side view mode.
Parameters:
Name Type Description
battlerName String

setCharacterImage(characterName, characterIndex)

Parameters:
Name Type Description
characterName String
characterIndex Number

setFaceImage(faceName, faceIndex)

Sets the face image of the actor given the face image (from database) and face index within the iamge.
Parameters:
Name Type Description
faceName String
faceIndex Number

setHp(hp)

Sets the battler hp.
Parameters:
Name Type Description
hp Number
Inherited From:

setLastBattleSkill(skill)

Parameters:
Name Type Description
skill RPG.Skill

setLastCommandSymbol(symbol)

Sets the last command symbol to the given symbol; this is the selected command in the battle menu.
Parameters:
Name Type Description
symbol String

setLastMenuSkill(skill)

Parameters:
Name Type Description
skill RPG.Skill

setLastTarget(target)

Parameters:
Name Type Description
target Game_Battler
Inherited From:

setMp(mp)

Sets the battler mp.
Parameters:
Name Type Description
mp Number
Inherited From:

setName(name)

Sets the actor name.
Parameters:
Name Type Description
name String

setNickname(nickname)

Sets the nickname of the actor.
Parameters:
Name Type Description
nickname String

setProfile(profile)

Sets the actor profile.
Parameters:
Name Type Description
profile String

setTp(tp)

Sets the battler tp.
Parameters:
Name Type Description
tp Number
Inherited From:

setup(actorId)

Parameters:
Name Type Description
actorId Number

shiftAnimation() → {MV.BattlerAnimation}

Shifts the battler animation.
Inherited From:
Returns:
Type
MV.BattlerAnimation

shouldDisplayLevelUp() → {Boolean}

Returns true if the actor should display level up in a message window.
Returns:
Type
Boolean

showAddedStates()

Shows the added states to the actor.

showRemovedStates()

Shows the removed states from the actor.

skillMpCost(skill) → {Number}

Returns the mp cost of the skill.
Parameters:
Name Type Description
skill RPG.Skill
Inherited From:
Returns:
Type
Number

skills() → {Array.<RPG.Skill>}

Returns the actor's skills; even if the skills are not usable.
Returns:
Type
Array.<RPG.Skill>

skillTpCost(skill) → {Number}

Returns the tp cost of the skill.
Parameters:
Name Type Description
skill RPG.Skill
Inherited From:
Returns:
Type
Number

slotType() → {Number}

Returns the battler slot type of a trait.
Inherited From:
Returns:
Type
Number

sortStates()

Sorts the states attached to the battler.
Inherited From:

sparam(sparamId) → {Number}

Parameters:
Name Type Description
sparamId Number
Inherited From:
Returns:
Type
Number

specialFlag(flagId) → {Boolean}

Parameters:
Name Type Description
flagId Number
Inherited From:
Returns:
Type
Boolean

speed() → {Number}

Returns the speed of the battler.
Inherited From:
Returns:
Type
Number

startAnimation(animationId, mirror, delay)

Starts the animation on the actor given the specified animation id; if mirror is set to true, the animation will be mirrored. If a delay is enter, the animation will be delayed.
Parameters:
Name Type Description
animationId Number
mirror Boolean
delay Number
Overrides:

startDamagePopup()

Starts a damage pop up on the battler.
Inherited From:

startWeaponAnimation(weaponImageId)

Starts the weapon animation on te battler given a weapon id.
Parameters:
Name Type Description
weaponImageId Number
Inherited From:

stateIcons() → {Array.<number>}

Returns the array of state icons attached to the battler; this is determined by the active states on the battler.
Inherited From:
Returns:
Type
Array.<number>

stateMotionIndex() → {Number}

Inherited From:
Returns:
Type
Number

stateOverlayIndex() → {Number}

Inherited From:
Returns:
Type
Number

stateRate(stateId) → {Number}

Parameters:
Name Type Description
stateId Number
Inherited From:
Returns:
Type
Number

stateResistSet() → {Array.<number>}

Inherited From:
Returns:
Type
Array.<number>

states() → {Array.<RPG.State>}

Returns the states applied to the battler.
Inherited From:
Returns:
Type
Array.<RPG.State>

stepsForTurn() → {Number}

Returns:
Type
Number

testEscape(item)

Parameters:
Name Type Description
item RPG.BaseItem

tpRate() → {Number}

Returns the percentage of the battler's tp left as a float.
Inherited From:
Returns:
Type
Number

tradeItemWithParty(newItem, oldItem) → {Boolean}

Trades the new item with the old item in the party inventory.
Parameters:
Name Type Description
newItem RPG.EquipItem
oldItem RPG.EquipItem
Returns:
Type
Boolean

traitObjects() → {Array.<*>}

Overrides:
Returns:
Type
Array.<*>

traits(code) → {Array.<RPG.Trait>}

Parameters:
Name Type Description
code Number
Inherited From:
Returns:
Type
Array.<RPG.Trait>

traitsPi(code, id) → {Number}

Parameters:
Name Type Description
code Number
id Number
Inherited From:
Returns:
Type
Number

traitsSet(code) → {Array.<number>}

Parameters:
Name Type Description
code Number
Inherited From:
Returns:
Type
Array.<number>

traitsSum(code, id) → {Number}

Parameters:
Name Type Description
code Number
id Number
Inherited From:
Returns:
Type
Number

traitsSumAll(code) → {Number}

Parameters:
Name Type Description
code Number
Inherited From:
Returns:
Type
Number

traitsWithId(code, id) → {Array.<RPG.Trait>}

Parameters:
Name Type Description
code Number
id Number
Inherited From:
Returns:
Type
Array.<RPG.Trait>

turnEndOnMap()

updateBuffTurns()

Updates the buff turns on battler.
Inherited From:

updateStateSteps(state)

Parameters:
Name Type Description
state RPG.State

updateStateTurns()

Inherited From:

usableSkills() → {Array.<RPG.Skill>}

Returns the usable skills of the actor.
Returns:
Type
Array.<RPG.Skill>

useItem(item)

Has theb attler use the given item.
Parameters:
Name Type Description
item RPG.UsableItem
Inherited From:

weaponImageId() → {Number}

Returns the weapon image id.
Inherited From:
Returns:
Type
Number

weapons() → {Array.<RPG.Weapon>}

Returns the weapon of the actor.
Returns:
Type
Array.<RPG.Weapon>

xparam(xparamId) → {Number}

Parameters:
Name Type Description
xparamId Number
Inherited From:
Returns:
Type
Number