NiAlphaPropertyGetTestFunction

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search

This is a command from NifSE.

Syntax

(short:testFunc) NiAlphaPropertyGetTestFunction short:nifID short:blockID
(short:testFunc) NiAlphaPropGetTestFunc short:nifID short:blockID

Returns the integer ID for the test function used by the NiAlphaProperty specified by blockID. 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 NiAlphaProperty, so this function will always require an explicit blockID.

Test Functions

The function of each value is equivalent to the OpenGL test function of similar name. These functions compare the alpha value of each pixel against the NiAlphaProperty's test threshold before painting it.

  • ALWAYS = 0
  • LESS = 1
  • EQUAL = 2
  • LEQUAL = 3
  • GREATER = 4
  • NOTEQUAL = 5
  • GEQUAL = 6
  • NEVER = 7

See Also[edit | edit source]