ClearObjectVisualTransform(object, int)

From NWN Lexicon
Revision as of 07:32, 18 March 2023 by Shadguy (talk | contribs) (first version)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search
Nwnee logo.jpg Note: This article documents Neverwinter Nights: Enhanced Edition new content or changes/updates/fixes to 1.69 functions. These are all listed under the category and patches pages.

Immediately unsets a VTs for the given object, with no lerp.

void ClearObjectVisualTransform(
    object oObject,
    int nScope = -1
);


Parameters

oObject
The object to clear visual transforms from.
nMask
The scope of visual transforms to clear.


Description

Immediately unsets a VTs for the given object, with no lerp.

* nScope: one of OBJECT_VISUAL_TRANSFORM_DATA_SCOPE_, or -1 for all scopes

Returns TRUE only if transforms were successfully removed (valid object, transforms existed).


Remarks

Information icon.png This section of the article is a stub. You can help the NWN Lexicon by expanding it.


Version

This function was added in 1.86.8193.35 of NWN:EE.


Example

Information icon.png This article is in need of examples. You can help the NWN Lexicon by showing how to use this code effectively.


See Also

constants:  OBJECT_VISUAL_TRANSFORM_DATA_SCOPE_* Constants
functions: EffectVisualEffect()

 author: Shadguy