EffectEntangle()

From NWN Lexicon
Revision as of 00:13, 7 March 2021 by Jasperre (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Create an Entangle effect

Description

When applied, this effect will restrict the creature's movement (causing them to drop to 3 dexterity) and apply a (-2) to all attacks and a -4 to dexterity.

Web is a form of Entangle, and uses the same effect (but, of course, you can't burn your way out...or laugh at someone doing it to the web anyway).

The target this effect is applied to must be a creature for it to work. This effect should not be applied instantly, only temporarily or permanently.


Remarks

Entangle is really useful for spells, such as...entangle! For traps and so on, it may be the same. It can only be stopped with direct immunity to Entangle.

The effects will not stack, but 2 or more entangles can be applied at the same time.

Effect functions are Constructors, which are special methods that help construct effect "objects". You can declare and link effects, and apply them using an ApplyEffectToObject() Command. Once applied, each effect can be got separately via looping valid effects on the target (GetFirst/NextEffect()). See the Effect Tutorial for more details.


Effect Breakdown

While this is a complex effect, it has no parameters available to GetEffectInteger or similar.

The internal effect are:

  • Stops the creatures actions when first applied (if they were moving they'd stop, ie; ClearAllActions on them, so a spell being cast is also "cancelled" as if the top left action queue was cleared)
  • Removal of the ability to use the legs on the target creature (AISTATE_CREATURE_USE_LEGS). This seems to set Dexterity to 3 as if paralyzed/flat footed/immobile, causes them to not be able to move, but still allows them to fight (cast spells, use ranged and melee weapons or items).
  • A hidden EffectAbilityDecrease(ABILITY_DEXTERITY, 4); - this doesn't really do anything additional, due to the above lack of legs, but in PnP D&D it would apply if they could move at half speed after breaking partially free of the entangle.
  • A hidden EffectAttackDecrease(2, ATTACK_BONUS_MISC); - this does apply as normal.
  • While applied and the creature casts a spell a concentration skill check against a DC of 15 is done before the spell can be cast. If failed the feedback will be "Your concentration has been disrupted by Entangle" without any additional "rolls" being displayed. Obviously having 14 or more concentration skill is enough to bypass this.
    • For some reason spells with UseConcentration set to 0, such as "Summon Familiar", can have this occur! This should be considered a bug.

Immunity is granted by IMMUNITY_TYPE_ENTANGLE which itself is not applied from any feats, although a few feats may be checked by spells scripts (eg: FEAT_WOODLAND_STRIDE).

If you apply more than one EffectEntangle they don't do anything as such, but all of them have to be removed to clear the effects.

Removing EffectEntangle while another is still in effect removes the effect icon, the red over the dexterity penalty, so it makes it appear as if you are not entangled on the character sheet/examine screen but all other effects still apply.

An alternative to Entangle which is similar is EffectCutsceneImmobilize. It removes the concentration check, and the other penalties can be done manually.

Known Bugs

The feedback of the concentration roll is not made clear to the player; only a simple message "Your concentration has been disrupted by Entangle" occurs and only on failure of the check.

Using feat-spells, even if the spells.2da line UseConcentration setting is set to 0, will still have the concentration check occur. In comparison usual in-game attacks/EffectDamage will not.

Removing EffectEntangle while another is still in effect removes the effect icon, the red over the dexterity penalty, so it makes it appear as if you are not entangled on your character sheet but all other effects still apply.

There is reports of the dexterity penalty remaining even when Entangle has gone in some cases, but need to still test this thoroughly.


Version

1.62

Example

// Sample code for applying entangle to a target
 
void main()
{
    // This is the Object to apply the effect to.
    object oTarget = OBJECT_SELF;
 
    // Create the effect to apply
    effect eEntangle = EffectEntangle();
 
    // Create the visual portion of the effect. This is instantly
    // applied and not persistent with whether or not we have the
    // above effect.
    effect eVis = EffectVisualEffect(VFX_IMP_SLOW);
 
    // Apply the visual effect to the target
    ApplyEffectToObject(DURATION_TYPE_INSTANT, eVis, oTarget);
    // Apply the effect to the object   
    ApplyEffectToObject(DURATION_TYPE_PERMANENT, eEntangle, oTarget);
}

See Also



 author: Michael Nork, editor: Jasperre, additional contributor(s): Jasperre