NiStencilPropertySetPassAction

From the Oblivion ConstructionSet Wiki
Revision as of 17:54, 23 January 2011 by imported>DragoonWraith (New page: This is a command from NifSE. '''Syntax''' (bool:success) NiStencilPropertySetPassAction short:stencilAct short:nifID ''short:blockID'' (bool:success) NiStencilPropS...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This is a command from NifSE.

Syntax

(bool:success) NiStencilPropertySetPassAction short:stencilAct short:nifID short:blockID
(bool:success) NiStencilPropSetPassAct short:stencilAct short:nifID short:blockID

Sets the pass action used by the NiStencilProperty specified by blockID. The pass action is the action taken if the stencil test evaluates to true. 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