Page tree
Skip to end of metadata
Go to start of metadata

Introduced in



Description:This smoothly runs an animation that has been configured for the Interact With Animations (IWA) system. These animations change instantaneously, if the animate command is used to animate them (this function must be used to animate them smoothly).

This function only starts the animation towards the desired target phase, but does not guarantee it will reach it. The animation can still be interrupted and changed with a new target phase by using this function again, or by using IWA.


Syntax:[target, animation, phase, continuous] call fn_vbs_animateIWA
  • target: Object - Object to be animated.
  • animation: String - Name of animation to run.
  • phase: Number - Target phase animation should run until (0-1).
  • continuous: Boolean - Optional (default: true). If false, animation only runs for one frame. If true, it runs until target phase is reached (or is changed to a new target).
Return Value:Boolean - Returns true if animation is started; false if the animation does not exist or is not configured for IWA.


When using functions in VBS versions older than 3.4, certain limitations and requirements should be kept in mind - the main ones being that capitalization of the function name is crucial, and that #include "\vbs2\headers\function_library.hpp" has to be included in every script that utilizes it. More Category VBS Scripting Functions.


[car1, "Door_1_1", 1] call fn_vbs_animateIWA

Additional Information

See also: