AnimaX plugin guide

animaxPluginGuide.md

AnimaX Plugin Guide (short) for RPG Maker MZ and MV

Full guide

Guide with examples how to setup and use the system you can find at my website

Plugin Directory

• Ensure all assets related to this plugin are placed in the following directory:
  • img\charactersAA\

Setup Animations for Characters

In the Plugin Parameters, add animations for your characters:

Actors:

• Add the following Note to the Actor:

  <xAnima:NAME>
  

  Replace NAME with the animation set's name.

Equipment (Weapons):

• Add the following Note to the Equipment:

  <xAnimaSet:NAME>
  

  Replace NAME with the animation set's name.

Events:

• Add the following Comment to the Event:

  XA:NAME
  

  Replace NAME with the animation set's name.

Extra Layers for Equipment

Add extra animation layers for equipment (weapons):

• To add a normal extra layer:

  <xAnimaLayer:NAME>
  

• To add a relative extra layer:

  <xAnimaLayerRelative:NAME>
  

Compatibility with Other Plugins

Using with Alpha ABS Z

• Ensure that Alpha ABS Z is placed below this plugin in the Plugin Manager.

Using with Alpha NET Z

• All plugin commands are automatically synchronized via the network.
• To execute a plugin command in local mode (no network sync), use this script call before the plugin command:

  PKD_ANIMAX.SetLocalMode();

Script Calls

1. Change Player Animation Set

• Change the player's animation set to a different profile:

  PKD_ANIMAX.ChangePlayerAnimationSet("profileName");

• Reset the player’s animation set to the default (from Actor's Note):

  PKD_ANIMAX.ResetPlayerAnimationSet();

2. Change Event Animation Set

• Change an event's animation set to a different profile:

  PKD_ANIMAX.ChangeEventAnimationSet(eventId, "profileName");

• Reset the event's animation set:

  PKD_ANIMAX.ResetEventAnimationSet(eventId);

• Example:

  PKD_ANIMAX.ChangeEventAnimationSet(3, "Wolf");

3. Play Animation Action

• Play an animation action for a character:

  PKD_ANIMAX.PlayAnimationAction("actionName", charId, isLoop, isWaitEnd);

  • actionName: Name of the action from the Actions List (leave empty to clear actions).
  • charId: Character ID (0 for Player, -1 for current Event, or Event ID).
  • isLoop: Set to true for looping animation.
  • isWaitEnd: Set to true to wait for the animation to complete before executing the next event commands.

  Example:

  PKD_ANIMAX.PlayAnimationAction("Attack", 0, false, true);

4. Play Independent Action

• Play an independent animation action from another profile:

  PKD_ANIMAX.PlayIndependentAction("profileName", "actionName", charId, isLoop, isWaitEnd);

  Example:

  PKD_ANIMAX.PlayIndependentAction("Wolf", "Defense", 54, true, true);

5. Stop Animation Action

• Stop any looping animation action for a character:

  PKD_ANIMAX.StopAnimationAction(charId);

6. Add Layer

• Add an extra animation layer to a character:

  PKD_ANIMAX.AddLayer(charId, "layerName", isRelative);

  • layerName: Name of the layer (from Animation Layers List).
  • isRelative: If false, the layer will be loaded from the CommonLayers folder. If true, it will be loaded from the character’s AnimaX folder.

  Example:

  PKD_ANIMAX.AddLayer(33, "Wings", false);

7. Remove Layer

• Remove a specific extra layer from a character:

  PKD_ANIMAX.RemoveLayer(charId, "layerName");

• Remove all layers from a character:

  PKD_ANIMAX.RemoveAllLayers(charId);

8. Disable/Enable AnimaX System

• Disable the AnimaX system:

  PKD_ANIMAX.DisableAnimaX();

• Enable the AnimaX system:

    PKD_ANIMAX.EnableAnimaX();

9. Disable/Enable AnimaX for Player or Followers

• Disable the AnimaX system:

    PKD_ANIMAX.SetAnimaXStateForPlayer(false);
    PKD_ANIMAX.SetAnimaXStateForPartyMember(MEMBER_INDEX, false);

• MEMBER_INDEX is the index of the party member (0 for the player, 1 for the first follower, 2 for second, etc.).

• Enable the AnimaX system:

    PKD_ANIMAX.SetAnimaXStateForPlayer(true);
    PKD_ANIMAX.SetAnimaXStateForPartyMember(MEMBER_INDEX, true);

Plugin Commands for RPG Maker MV Users

1. Change Player Animation Set

ChangePlayerAnimationSet ANIMATION_SET_NAME

• Replace ANIMATION_SET_NAME with the desired animation set from the Animations List.

2. Reset Player Animation Set

ResetPlayerAnimationSet

3. Change Event Animation Set

ChangeEventAnimationSet EVENT_ID ANIMATION_SET_NAME

• Replace EVENT_ID with the event's ID and ANIMATION_SET_NAME with the desired animation set.

• EVENT_ID can be -1 for the current event. 0 - for player. Any number - for event ID.

• For reference player followers use -2, -3, -4

• This valid for all commands below where you specify CHAR_ID or EVENT_ID

4. Play Animation Action

PlayAnimationAction ACTION_NAME CHAR_ID IS_LOOP IS_WAIT

• Replace ACTION_NAME with the action name, CHAR_ID with the character's ID, IS_LOOP with true or false, and IS_WAIT with true or false.

5. Play Independent Action

PlayIndependentAction ANIMATION_SET_NAME ACTION_NAME CHAR_ID IS_LOOP IS_WAIT

• Play an independent animation action for a character with a different or no AnimaX profile.

6. Stop Animation Action

StopAnimationAction CHAR_ID

7. Add Animation Layer

AddAnimaLayer CHAR_ID LAYER_NAME IS_RELATIVE

8. Remove Animation Layer

RemoveAnimaLayer CHAR_ID LAYER_NAME

9. Clear All Animation Layers

ClearAnimaLayers CHAR_ID

10. Disable/Enable AnimaX System

EnableAnimaX
DisableAnimaX

11. Disable/Enable AnimaX for Player or Followers

SetAnimaXStateForParty INDEX STATE

• INDEX = 0 - for player, 1 - for first follower, 2 - for second, etc.
• Example: SetAnimaXStateForParty 0 false