NiStencilPropertyGetFailAction

This is a command from NifSE.

Syntax

(short:stencilAct) NiStencilPropertyGetFailAction short:nifID short:blockID
(short:stencilAct) NiStencilPropGetFailAct short:nifID short:blockID

Returns the integer ID for the fail action used by the NiStencilProperty specified by blockID. The fail action is the action taken if the stencil test evaluates to false. The possible values and their meanings are indicated below.

Returns -1 if the function fails for any reason.

The default value of blockID, 0, indicates the NIF's root, a NiNode. NiNode blocks are not derived from NiStencilProperty, so this function will always require an explicit blockID.

Stencil Actions

• KEEP = 0
• ZERO = 1
• REPLACE = 2
• INCREMENT = 3
• DECREMENT = 4
• INVERT = 5

See Also

• NiStencilPropertySetFailAction