The game object class for the party. Information such as gold and items is included.
Extends
Members
- Default Value:
- 2
- Default Value:
- 5
- Default Value:
- 1
- Default Value:
- 4
- Default Value:
- 3
Methods
- Add an actor to the party by id
Name Type Description actorIdnumber The id of the actor to add agility()numberinherited
- Get the unit's agility
Returns:
Type Description number The unit's agility aliveMembers()Arrayinherited
- Get unit members who are alive
Returns:
Type Description Array Unit members who are alive allBattleMembers()Array.<Game_Actor>
- Get all possible battle party members
- Since:
- Version 1.4.0
Returns:
Type Description Array.<Game_Actor> All battle party members - Get the party's items, weapons, and armors
Returns:
Type Description Array Data objects for all items, weapons, armors allMembers()Array.<Game_Actor>
- Get all possible party members
Returns:
Type Description Array.<Game_Actor> All party members - Get the party's armors
Returns:
Type Description Array Data objects for all armors battleMembers()Array.<Game_Actor>
- Get all battle party members
Returns:
Type Description Array.<Game_Actor> All battle party members - Check if any party members can input
Returns:
Type Description boolean True if any party member can input - Check if the given item can be used
Name Type Description itemObject The item to check Returns:
Type Description boolean True if any party member can use the item - Get character info for save file
Returns:
Type Description Array Character info for the save file clearActions()inherited
- Clear all member actions
clearResults()inherited
- Clear results for all members
- Consumes an item
Name Type Description itemObject The item to consume deadMembers()Arrayinherited
- Get unit members who are dead
Returns:
Type Description Array Unit members who are dead - Discards equipment from party members
Name Type Description itemObject The equip item to discard amountnumber The amount of that item to discard - Get the party's equipable items (weapons + armors)
Returns:
Type Description Array Data objects for all equipable items - Check if the party exists (more than 1 actor in it)
Returns:
Type Description boolean True if exists - Get face info for save file
Returns:
Type Description Array Face info for the save file - Gains gold
Name Type Description amountnumber The amount of gold to gain - Gains items
Name Type Description itemObject The item to gain amountnumber The amount of the item to gain includeEquipboolean If party member equips should be discarded when amount is negative - Get the party's gold amount
Returns:
Type Description number Amount of gold the party has - Check if the party has cancel surprise ability
Returns:
Type Description boolean True if cancel surprise - Check if the party has drop item double ability
Returns:
Type Description boolean True if drop item double - Check if the party has encounter half ability
Returns:
Type Description boolean True if encounter half - Check if the party has encounter none ability
Returns:
Type Description boolean True if encounter none - Check if the party has gold double ability
Returns:
Type Description boolean True if gold double - Check if the party has any of the given item
Name Type Description itemObject The item to check includeEquipboolean If should check actor equips too Returns:
Type Description boolean True if the party has the given item - Check if the party has the maximum allowed amount of the given item
Name Type Description itemObject The item to check Returns:
Type Description boolean True if already has max items - Check if the party has raise preemptive ability
Returns:
Type Description boolean True if raise preemptive hiddenBattleMembers()Array.<Game_Actor>
- Get all hidden battle party members
- Since:
- Version 1.4.0
Returns:
Type Description Array.<Game_Actor> All hidden battle party members - Get the highest level of any party member
Returns:
Type Description number The highest level inBattle()booleaninherited
- Check if the unit is in battle
Returns:
Type Description boolean True if in battle - Increase the step counter by one
- Initializes the items/weapons/armors
- Initialize the unit
- Check if all members are dead
Returns:
Type Description boolean True if all members are dead - Check if any party member has the given item equipped
Name Type Description itemObject The item to check Returns:
Type Description boolean True if any party member has the item equipped - Check if there are no party members
Returns:
Type Description boolean True if no party members - Check if the party escaped
Name Type Description item* Unused - Since:
- Version 1.4.0
Returns:
Type Description boolean True if escaped - Get the item container for the given item. For example, it will return the armor container if the given item is an armor.
Name Type Description itemObject The item object to get the container for Returns:
Type Description Array|null Objects for all items of similar type, null if no container found - Get the party's items
Returns:
Type Description Array Data objects for all items - Get the last item
Returns:
Type Description Object The last item data object leader()Game_Actor
- Get the party leader
Returns:
Type Description Game_Actor Party member in first position - Loses gold
Name Type Description amountnumber The amount of gold to lose - Loses items
Name Type Description itemObject The item to lose amountnumber The amount of the item to lose includeEquipboolean If party member equips should be discarded if there are not enough items in the inventory to lose makeActions()inherited
- Make member's actions
- Make the next menu actor
- Make the previous menu actor
- Get the maximum amount of battlers
Returns:
Type Description number Maximum amount of battle members to allow - Get the maximum amount of gold allowed
Returns:
Type Description number Max allowed amount of gold - Get the maximum amount of items allowed
Returns:
Type Description number Max allowed amount of any item members()Array.<Game_Actor>overrides
- Get the members of the party
Returns:
Type Description Array.<Game_Actor> Member array menuActor()Game_Actor
- Get the menu actor
Returns:
Type Description Game_Actor The menu actor movableMembers()Arrayinherited
- Get unit members who can move
Returns:
Type Description Array Unit members who can move - Get the name to use for the party
Returns:
Type Description string The name of the party - Get the amount of the given item the party has
Name Type Description itemObject The item to check Returns:
Type Description number The amount of the given item the party has onBattleEnd()inherited
- Processing when battle ends
onBattleStart(advantageous)inherited
- Processing when battle starts
Name Type Description advantageousboolean If the unit has the advantage - Handling when escape fails
- Processing when the player is walking
- Check if any battle member has the party ability by id
Name Type Description abilityIdnumber The party ability id to check for Returns:
Type Description boolean True if party ability found - Perform escape for each member
- Perform victory for each member
randomDeadTarget()Game_Enemy | Game_Actorinherited
- Pick a random dead target in the unit
Returns:
Type Description Game_Enemy|Game_Actor The dead target that was chosen randomTarget()Game_Enemy | Game_Actorinherited
- Pick a random target in the unit
Returns:
Type Description Game_Enemy|Game_Actor The target that was chosen - Get the preemptive rate
Name Type Description troopAginumber The troop's agility Returns:
Type Description number The preemptive rate - Get the surprise rate
Name Type Description troopAginumber The troop's agility Returns:
Type Description number The surprise rate - Remove an actor from the party by id
Name Type Description actorIdnumber The id of the actor to remove - Remove member battle states
- Remove any invalid party members (no corresponding data object)
- Request motion refresh for members
- Revives all dead party members
select(member)inherited
- Select a member of the unit
Name Type Description memberGame_Actor|Game_Enemy The member to select - Set the last item
Name Type Description TheObject new last item - Set the menu actor
Name Type Description actorGame_Actor The new menu actor - Set the menu actor
Name Type Description actorGame_Actor The new target actor - Set up performed when doing a battle test
- Set up items available during the battle test
- Set up battler members when doing battle test
- Sets up the starting party members
- Get the party size
Returns:
Type Description number Number of party members smoothDeadTarget(index)Game_Enemy | Game_Actorinherited
- Choose a dead target by id
Name Type Description indexnumber The index of the target Returns:
Type Description Game_Enemy|Game_Actor The target that was chosen smoothTarget(index)Game_Enemy | Game_Actorinherited
- Choose a target by id
Name Type Description indexnumber The index of the target Returns:
Type Description Game_Enemy|Game_Actor The target that was chosen - Get the party's step count
Returns:
Type Description number Amount of steps taken substituteBattler(target)Game_Actor | Game_Enemy | nullinherited
- Get the substitute battler
Name Type Description targetGame_Battler The original target Returns:
Type Description Game_Actor|Game_Enemy|null The substitute battler, may be null if none found - Swap two member's positions in the party
Name Type Description index1number The first index to swap index2number The second index to swap targetActor()Game_Actor
- Get the target actor
Returns:
Type Description Game_Actor The target actor tgrSum()numberinherited
- Sum the unit's target rate
Returns:
Type Description number Unit target rate sum tpbBaseSpeed()numberinherited
- Get the TPB base speed
Returns:
Type Description number TPB base speed tpbReferenceTime()numberinherited
- Get the TPB reference time
Returns:
Type Description number TPB reference time updateTpb()inherited
- Update TPB
- Get the party's weapons
Returns:
Type Description Array Data objects for all weapons