EffectPolymorph(int, int)

Create a Polymorph effect that changes the target into a different type of creature.

effect EffectPolymorph(
    int nPolymorphSelection,
    int nLocked = FALSE
);

Parameters

nPolymorphSelection

POLYMORPH_TYPE_*

nLocked

If TRUE, player can't cancel polymorph (Default: FALSE)


Description

Returns a new effect object that when applied to a target will transform them into one of the types defined in the POLYMORPH_TYPE_* constant group, from the "polymorph.2da" file, where new ones can be added via. a hakpack.

A new polymorph will cancle out an exsisting one, and if nLocked is TRUE, there is no "Cancle Polymorph" in the radical menu, so it cannot be removed automatically by a PC, only by the duration running out, or (if applied via. a spell) it being dispelled.



Remarks

Constructors are special methods that return a new instance of an object. In NWN Script each effect that you can place on an object has it’s own constructor that creates a new instance of the specified effect. This effect object can then be used in an ApplyEffectToObject() Command. See Effect Constructor for more details.

There may be polymorph types that can be used but which don't have a constant associated with it. All the different POLYMORPH_TYPE constants are just integers referencing a row number in your polymorph.2da file. Look in this file to see if there are further polymorphs available for you.


Version

1.61

See Also

functions: SetCreatureAppearanceType
categories: Effects Functions | Spells Functions
constants: POLYMORPH_TYPE_* Constants


 author: John Shuell, editor: Jasperre
 Send comments on this topic.