# NIF File Format Documentation

NIF Objects | Compound Types | Enum Types | Basic Types | File Versions

## NiStencilProperty

Allows control of stencil testing.

### Attributes

Name | Type | Arg | Arr1 | Arr2 | Cond | Description | From | To
--- | --- | --- | --- | --- | --- | --- | --- | ---
From NiObject
From NiObjectNET
Skyrim Shader Type | BSLightingShaderPropertyShaderType |  |  |  | IsDerivedType(BSLightingShaderProperty::TYPE) | Configures the main shader path |  |
Name | string |  |  |  |  | Name of this controllable object, used to refer to the object in .kf files. |  |
Has Old Extra Data | bool |  |  |  |  | Extra data for pre-3.0 versions. |  | 2.3
Old Extra Prop Name | string |  |  |  | hasOldExtraData | (=NiStringExtraData) |  | 2.3
Old Extra Internal Id | uint |  |  |  | hasOldExtraData | ref |  | 2.3
Old Extra String | string |  |  |  | hasOldExtraData | Extra string data. |  | 2.3
Unknown Byte | byte |  |  |  |  | Always 0. |  | 2.3
Extra Data | Ref<NiExtraData> |  |  |  |  | Extra data object index. (The first in a chain) | 3.0 | 4.2.2.0
Num Extra Data List | uint |  |  |  |  | The number of Extra Data objects referenced through the list. | 10.0.1.0 |
Extra Data List | Ref<NiExtraData> |  | Num Extra Data List |  |  | List of extra data indices. | 10.0.1.0 |
Controller | Ref<NiTimeController> |  |  |  |  | Controller object index. (The first in a chain) | 3.0 |
From NiProperty
From NiStencilProperty
Flags | Flags |  |  |  |  | Property flags. |  | 10.0.1.2
Stencil Enabled | byte |  |  |  |  | Enables or disables the stencil test. |  | 20.0.0.5
Stencil Function | StencilCompareMode |  |  |  |  | Selects the compare mode function (see: glStencilFunc). |  | 20.0.0.5
Stencil Ref | uint |  |  |  |  | Unknown. Default is 0. |  | 20.0.0.5
Stencil Mask | uint |  |  |  |  | A bit mask. The default is 0xffffffff. |  | 20.0.0.5
Fail Action | StencilAction |  |  |  |  | Unknown. |  | 20.0.0.5
Z Fail Action | StencilAction |  |  |  |  | Unknown. |  | 20.0.0.5
Pass Action | StencilAction |  |  |  |  | Unknown. |  | 20.0.0.5
Draw Mode | FaceDrawMode |  |  |  |  | Used to enabled double sided faces. Default is 3 (DRAW_BOTH). |  | 20.0.0.5
Flags | Flags |  |  |  |  | Property flags: Bit 0: Stencil Enable Bits 1-3: Fail Action Bits 4-6: Z Fail Action Bits 7-9: Pass Action Bits 10-11: Draw Mode Bits 12-14: Stencil Function | 20.1.0.3 |
Stencil Ref | uint |  |  |  |  | Unknown. Default is 0. | 20.1.0.3 |
Stencil Mask | uint |  |  |  |  | A bit mask. The default is 0xffffffff. | 20.1.0.3 |

### Parent Of