Warp Command w/Animation

[Binarynova]

Hi there! I'm playing with command scripts as an easy way to get started with the project and had an idea I wanted to implement. I have set up a !warp command that successfully warps the player to their home point using player:addStatusEffectEx(xi.effect.TELEPORT, 0, xi.teleport.id.WARP, 0, 3). But there's no animation, so it seems like nothing is happening for a moment before the scene changes.

I had seen in the item_animations.txt file that 80 was the warp animation. It was a long shot, but I attempted to use player:setAnimation(80) and it didn't work out: I guess for the player 80 is the sitting animation. So the player sat in midair and then teleported. ;)

So, after doing some more searching and coming up short, I thought I'd ask here. Is there a line I could add to my custom command script to play the BLM warp animation before the warp occurs?

[RAIST5150]

Haven't tried to track it down... but wonder if you might be able to "cheat" with the function(s) called in the warp lua itself?

[UmeboshiXI]

You will probably need to use injectActionPacket for this.

This is from the !injectaction command.
player:injectActionPacket(target:getID(), actionId, animationId, speceffect, reaction, message, 10, 1)

• Player in this example is the action initiator. It would be the entity casting the spell/skill/whatever.
• target:getID() is obviously the target of the effect.
• actionId is the index of the action being performed. You can find these in the action.lua file in scripts/enums. It controls what animation sets are displayed.
• animationId is the animation you want to display.

Examples:
This would give the effect of a player casting warp on themself.

player:injectActionPacket(player:getID(), 4, 261, 0, 0, 0, 10, 1)
Here we have actionId set to 4 which correlates to MAGIC_FINISH = 4, in action enums. This set the so that you can display spell animation effects. 261 is the animation ID for Warp (You can find spell animations in spell_data.sql)

This is likely the item warp animation you mentioned above.

player:injectActionPacket(player:getID(), 5, 80, 0, 0, 0, 10, 1)

action ID is set to ITEM_FINISH = 5 so the client will display animations used by items. 80 is something like a warp ring effect.

Edit: Adding onto this. This only controls visual animations. You would want to use this above your warp command. If I remember correctly, the warp status effect already has a delay attached to it so the animations will likely line up with the zoning. If not you could use a timer to sync up the animation with the teleporting.

[Binarynova]

This worked! Using action_enum 4 and animation ID 261 gives the end of the casting animation as if cast by a BLM, and using 5, 80 plays the ending of the item animation as if using an item. Both of these work well enough alone and your post gives me enough info to clean it up even more if I want to add the starting animation of either one.

Thank you so much!