SetObjectActive

This page was generated by Sunjammer's Dragon Age Script Parser.

The parser extracted and matched all the information required to the best of its ability however the parser relies on the source file, and especially a function's comments, to be correctly formatted. If the source file was not correctly formatted the information presented may be incomplete.

This page should be reviewed by a knowledgeable scripter as it may require updating. If an issue with the source file is identified it should be reported to BioWare.

Please remove the {{Generated}} tag once the page has been confirmed or corrected.

Enables or disables an object in the engine. Creatures that belong to a pool will automatically return to it when set inactive.

void SetObjectActive(
object oObject,
int nActive,
int nAnimation = 0,
int nVFX = 0
);

Parameters:

oObject

The object to set status on

nActive

Non-zero is active, zero is inactive

nAnimation

The ID of an appear/disappear animation to play

nVFX

The ID of a VFX to add while the animation is playing

Returns:

Nothing.

Source:

script.ldf

Description

Each game engine object has a boolean enabled or disabled flag in the engine.