BlzSpecialEffectClearSubAnimations

Parameters

whichEffect

effect

comment

Clears all subanimations (tags) of the special effect. It does not affect normal animations.

Example usage of subanimations:

// if you play anim attack it becomes attack slam:
call BlzSpecialEffectAddSubAnimation(fx, SUBANIM_TYPE_SLAM)
call BlzPlaySpecialEffect(fx, ANIM_TYPE_SPELL)
call BlzSpecialEffectRemoveSubAnimation(fx, SUBANIM_TYPE_SLAM)

Examples of animations, animation names:

stand | birth | death | decay | dissipate | walk | attack | morph | sleep | spell | portrait

Examples of subanimations (tags), subanimation names:

first | second | third | fourth | fifth | defend | channel | slam | victory | throw | spin |
ready | upgrade | lumber | gold | work | talk | swim | flesh | entangle | chainlightning | rooted |
eattree | berserk | spiked | light | moderate | severe | critical | small | medium | large | alternateex |
looping | wounded | fast | turn | left | right | fire | one | two | three | four | five | fill |
puke | drain | flail | hit | off | complete

note

The constant for the animation name "cinematic" isn't defined in common.j, but it's accessible from the API via its integer key 0x800000.

ANIM_TYPE_CINEMATIC = ConvertAnimType(8388608)

patch

1.30.0.9655

Source

common.j (suggest an edit or discuss on Github)

return type

nothing

Source code

native BlzSpecialEffectClearSubAnimations          takes effect whichEffect returns nothing