Difference between revisions of "NiStencilPropertySetPassAction"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>DragoonWraith
(New page: This is a command from NifSE. '''Syntax''' (bool:success) NiStencilPropertySetPassAction short:stencilAct short:nifID ''short:blockID'' (bool:success) NiStencilPropS...)
 
imported>DragoonWraith
 
Line 7: Line 7:
Sets the pass action used by the [[:Category:NifSE (NiStencilProperty)|<tt>NiStencilProperty</tt>]] specified by <tt>blockID</tt>. The pass action is the action taken if the [[NiStencilPropertyGetStencilFunction|stencil test]] evaluates to true. The possible values and their meanings are indicated below.
Sets the pass action used by the [[:Category:NifSE (NiStencilProperty)|<tt>NiStencilProperty</tt>]] specified by <tt>blockID</tt>. The pass action is the action taken if the [[NiStencilPropertyGetStencilFunction|stencil test]] evaluates to true. The possible values and their meanings are indicated below.


Returns -1 if the function fails for any reason.
Returns 1 if successful, 0 otherwise.


The default value of <tt>blockID</tt>, 0, indicates the NIF's root, a [[:Category:NifSE (NiNode)|<tt>NiNode</tt>]]. <tt>NiNode</tt> blocks are not derived from <tt>NiStencilProperty</tt>, so this function will always require an explicit <tt>blockID</tt>.
The default value of <tt>blockID</tt>, 0, indicates the NIF's root, a [[:Category:NifSE (NiNode)|<tt>NiNode</tt>]]. <tt>NiNode</tt> blocks are not derived from <tt>NiStencilProperty</tt>, so this function will always require an explicit <tt>blockID</tt>.

Latest revision as of 17:55, 23 January 2011

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 successful, 0 otherwise.

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[edit | edit source]