Package pyffi :: Package formats :: Package nif :: Class NifFormat
[hide private]
[frames] | no frames]

Class NifFormat

source code

              object --+        
                       |        
object_models.FileFormat --+    
                           |    
object_models.xml.FileFormat --+
                               |
                              NifFormat

This class contains the generated classes from the xml.
Nested Classes [hide private]
  ulittle32
Little endian 32 bit unsigned integer (ignores specified data byte order).
  int
Basic implementation of a 32-bit signed integer type.
  uint
Implementation of a 32-bit unsigned integer type.
  byte
Implementation of a 8-bit unsigned integer type.
  char
Implementation of an (unencoded) 8-bit character.
  short
Implementation of a 16-bit signed integer type.
  ushort
Implementation of a 16-bit unsigned integer type.
  float
Implementation of a 32-bit float.
  BlockTypeIndex
Implementation of a 16-bit unsigned integer type.
  StringIndex
Implementation of a 32-bit unsigned integer type.
  SizedString
Basic type for strings.
  StringOffset
This is just an integer with -1 as default value.
  bool
Basic implementation of a 32-bit (8-bit for versions > 4.0.0.2) boolean type.
  Flags
  Ref
Reference to another block.
  Ptr
A weak reference to another block, used to point up the hierarchy tree.
  LineString
Basic type for strings ending in a newline character (0x0a).
  HeaderString
  FileVersion
  ShortString
Another type for strings.
  string
  FilePath
A file path.
  ByteArray
Array (list) of bytes.
  ByteMatrix
Matrix of bytes.
  NifError
Standard nif exception class.
  Data
A class to contain the actual nif data.
  Footer
  Header
  Matrix33
  Vector3
  Vector4
  SkinPartition
  bhkBoxShape
  bhkCapsuleShape
  bhkConstraint
  bhkConvexVerticesShape
  bhkLimitedHingeConstraint
  bhkListShape
  bhkMalleableConstraint
  bhkMoppBvTreeShape
  bhkMultiSphereShape
  bhkNiTriStripsShape
  bhkPackedNiTriStripsShape
  bhkRagdollConstraint
  bhkRefObject
  bhkRigidBody
  bhkSphereShape
  bhkTransformShape
  BSBound
  BSDismemberSkinInstance
  ControllerLink
  hkPackedNiTriStripsData
  InertiaMatrix
  LimitedHingeDescriptor
  Matrix44
  NiAVObject
  NiBSplineCompTransformInterpolator
  NiBSplineData
  NiBSplineInterpolator
  NiBSplineTransformInterpolator
  NiControllerSequence
  NiGeometryData
  NiGeometry
  NiKeyframeData
  NiMaterialColorController
  NiMorphData
  NiNode
  NiObjectNET
  NiObject
  NiMaterialProperty
  ATextureRenderData
  NiSkinData
  NiTransformInterpolator
  NiTriBasedGeomData
  NiTriBasedGeom
  NiTriShapeData
Example usage:
  NiTriStripsData
Example usage:
  RagdollDescriptor
  SkinData
  StringPalette
  TexCoord
  NiPSysData
  AVObject
Used in NiDefaultAVObjectPalette.
  AbstractAdditionalGeometryData
  AdditionalDataBlock
  AdditionalDataInfo
  AlphaFormat
An unsigned 32-bit integer, describing how transparency is handled in a texture.
  ApplyMode
An unsigned 32-bit integer, describing the apply mode of a texture.
  ArkTexture
A texture reference used by NiArkTextureExtraData.
  AvoidNode
Morrowind specific?
  BSAnimNotes
Bethesda-specific node.
  BSBlastNode
Bethesda-Specific node.
  BSDamageStage
Bethesda-Specific node.
  BSDebrisNode
Bethesda-Specific node.
  BSDecalPlacementVectorExtraData
Bethesda-specific node.
  BSDismemberBodyPartType
  BSDistantTreeShaderProperty
Bethesda-specific node.
  BSFadeNode
Bethesda-specific fade node.
  BSFrustumFOVController
Bethesda-specific node.
  BSFurnitureMarker
Unknown.
  BSKeyframeController
An extended keyframe controller.
  BSMasterParticleSystem
Bethesda-Specific node.
  BSMaterialEmittanceMultController
Bethesda-Specific node.
  BSMultiBound
Bethesda-specific node.
  BSMultiBoundAABB
Bethesda-specific node.
  BSMultiBoundData
Abstract base type for bounding data.
  BSMultiBoundNode
Bethesda-specific node.
  BSMultiBoundSphere
Bethesda-specific node.
  BSOrderedNode
Bethesda-Specific node.
  BSPSysArrayEmitter
Particle emitter that uses a node, its children and subchildren to emit from.
  BSPSysMultiTargetEmitterCtlr
Particle system (multi?) emitter controller.
  BSPSysSimpleColorModifier
Bethesda-Specific Particle node.
  BSPSysStripUpdateModifier
Bethesda-Specific (mesh?) Particle System Modifier.
  BSPackedAdditionalDataBlock
  BSPackedAdditionalGeometryData
  BSParentVelocityModifier
Particle modifier that adds a blend of object space translation and rotation to particles born in world space.
  BSPartFlag
  BSRefractionFirePeriodController
Bethesda-specific node.
  BSRefractionStrengthController
Bethesda-Specific node.
  BSRotAccumTransfInterpolator
  BSSegmentedTriShape
Bethesda-specific node.
  BSSegmentedTriangle
Bethesda-specific node.
  BSShaderFlags
  BSShaderLightingProperty
Bethesda-specific property.
  BSShaderNoLightingProperty
Bethesda-specific property.
  BSShaderPPLightingProperty
Bethesda-specific Shade node.
  BSShaderProperty
Bethesda-specific Property node
  BSShaderTextureSet
Bethesda-specific Texture Set.
  BSShaderType
The type of animation interpolation (blending) that will be used on the associated key frames.
  BSStripPSysData
Bethesda-Specific (mesh?) Particle System Data.
  BSStripParticleSystem
Bethesda-Specific (mesh?) Particle System.
  BSTreadTransfInfo
Bethesda-specific node.
  BSTreadTransfInterpolator
Bethesda-specific node.
  BSTreadTransfSubInfo
Bethesda-specific node.
  BSValueNode
Bethesda-Specific node.
  BSWArray
Bethesda-specific node.
  BSWindModifier
Particle Modifier that uses the wind value from the gamedata to alter the path of particles.
  BSXFlags
Controls animation and collision.
  BillboardMode
Determines the way the billboard will react to the camera.
  BodyPartList
Body part list for DismemberSkinInstance
  BoundVolumeType
  BoundingBox
Bounding box.
  BoundingVolume
  BoxBV
Box Bounding Volume
  ByteColor3
A color without alpha (red, green, blue).
  ByteColor4
A color with alpha (red, green, blue, alpha).
  CStreamableAssetData
  CapsuleBV
Capsule Bounding Volume
  ChannelConvention
  ChannelData
Channel data
  ChannelType
  CloningBehavior
Sets how objects are to be cloned.
  CollisionMode
  Color3
A color without alpha (red, green, blue).
  Color4
A color with alpha (red, green, blue, alpha).
  ComponentFormat
The data format of components.
  ConsistencyType
Used by NiGeometryData to control the volatility of the mesh.
  CoordGenType
Determines the way that UV texture coordinates are generated.
  CycleType
The animation cyle behavior.
  DataStreamAccess
  DataStreamUsage
Determines how a data stream is used?
  DeactivatorType
  DecalVectorArray
Array of Vectors for Decal placement in BSDecalPlacementVectorExtraData.
  DecayType
Determines decay function.
  DistantLODShaderProperty
Bethesda-specific node.
  EffectType
The type of information that's store in a texture used by a NiTextureEffect.
  ElementReference
  EmitFrom
Controls which parts of the mesh that the particles are emitted from.
  EndianType
  ExportInfo
  ExtraMeshDataEpicMickey
  ExtraMeshDataEpicMickey2
  FaceDrawMode
This enum lists the different face culling options.
  FieldType
The force field's type.
  ForceType
The type of force? May be more valid values.
  FurniturePosition
Describes a furniture position?
  FxButton
Unknown.
  FxRadioButton
Unknown.
  FxWidget
Firaxis-specific UI widgets?
  HairShaderProperty
Bethesda-specific node.
  HalfSpaceBV
  HavokMaterial
A material, used by havok shape objects.
  HingeDescriptor
  ImageType
Determines how the raw image data is stored in NiRawImageData.
  Key
A generic key with support for interpolation.
  KeyGroup
Array of vector keys (anything that can be interpolated, except rotations).
  KeyType
The type of animation interpolation (blending) that will be used on the associated key frames.
  LODRange
The distance range where a specific level of detail applies.
  LightMode
An unsigned 32-bit integer, describing how vertex colors influence lighting.
  Lighting30ShaderProperty
Bethesda-specific node.
  MatchGroup
Group of vertex indices of vertices that match.
  MaterialData
Data stored per-material by NiRenderObject
  Matrix22
A 2x2 matrix of float values.
  MeshData
  MeshPrimitiveType
Describes the type of primitives stored in a mesh object.
  MipMap
Description of a MipMap within a NiPixelData object.
  MipMapFormat
An unsigned 32-bit integer, describing how mipmaps are handled in a texture.
  Morph
Geometry morphing data component.
  MorphWeight
  MotionQuality
The motion type.
  MotionSystem
The motion system.
  MotorDescriptor
  MultiTextureElement
  Ni3dsAlphaAnimator
Unknown.
  Ni3dsAnimationNode
Unknown.
  Ni3dsColorAnimator
Unknown!
  Ni3dsMorphShape
Unknown!
  Ni3dsParticleSystem
Unknown!
  Ni3dsPathController
Unknown!
  NiAVObjectPalette
Unknown.
  NiAdditionalGeometryData
  NiAlphaController
Time controller for transparency.
  NiAlphaProperty
Transparency.
  NiAmbientLight
Ambient light source.
  NiArkAnimationExtraData
Unknown node.
  NiArkImporterExtraData
Unknown node.
  NiArkShaderExtraData
Unknown node.
  NiArkTextureExtraData
Unknown node.
  NiArkViewportInfoExtraData
Unknown node.
  NiAutoNormalParticles
Unknown.
  NiAutoNormalParticlesData
Particle system data object (with automatic normals?).
  NiBSAnimationNode
Bethesda-specific extension of Node with animation properties stored in the flags, often 42?
  NiBSBoneLODController
A simple LOD controller for bones.
  NiBSPArrayController
A particle system controller, used by BS in conjunction with NiBSParticleNode.
  NiBSParticleNode
Unknown.
  NiBSplineBasisData
Stores the number of control points of a B-spline.
  NiBSplineCompFloatInterpolator
Unknown.
  NiBSplineCompPoint3Interpolator
Unknown.
  NiBSplineCompTransformEvaluator
  NiBSplineFloatInterpolator
Unknown.
  NiBSplinePoint3Interpolator
Unknown.
  NiBezierMesh
Unknown
  NiBezierTriangle4
Sub data of NiBezierMesh
  NiBillboardNode
These nodes will always be rotated to face the camera creating a billboard effect for any attached objects.In pre-10.1.0.0 the Flags field is used for BillboardMode.Bit 0: hiddenBits 1-2: collision modeBit 3: unknown (set in most official meshes)Bits 5-6: billboard modeCollision modes:00 NONE01 USE_TRIANGLES10 USE_OBBS11 CONTINUEBillboard modes:00 ALWAYS_FACE_CAMERA01 ROTATE_ABOUT_UP10 RIGID_FACE_CAMERA11 ALWAYS_FACE_CENTER
  NiBinaryExtraData
Binary extra data object.
  NiBinaryVoxelData
Voxel data object.
  NiBinaryVoxelExtraData
Voxel extra data object.
  NiBlendBoolInterpolator
An interpolator for a bool.
  NiBlendFloatInterpolator
An interpolator for a float.
  NiBlendInterpolator
An extended type of interpolater.
  NiBlendPoint3Interpolator
Interpolates a point?
  NiBlendTransformInterpolator
Unknown.
  NiBone
A NiNode used as a skeleton bone?
  NiBoneLODController
Level of detail controller for bones.
  NiBoolData
Timed boolean data.
  NiBoolInterpController
A controller that interpolates floating point numbers?
  NiBoolInterpolator
Unknown.
  NiBoolTimelineInterpolator
Unknown.
  NiBooleanExtraData
Boolean extra data.
  NiCamera
Camera object.
  NiClod
A shape node that holds continuous level of detail information.Seems to be specific to Freedom Force.
  NiClodData
Holds mesh data for continuous level of detail shapes.Pesumably a progressive mesh with triangles specified by edge splits.Seems to be specific to Freedom Force.The structure of this is uncertain and highly experimental at this point.No file with this data can currently be read properly.
  NiClodSkinInstance
A copy of NISkinInstance for use with NiClod meshes.
  NiCollisionData
Collision box.
  NiCollisionObject
This is the most common collision object found in NIF files.
  NiColorData
Color data for material color controller.
  NiColorExtraData
Unknown.
  NiControllerManager
Unknown.
  NiDataStream
  NiDefaultAVObjectPalette
Unknown.
  NiDirectionalLight
Directional light source.
  NiDitherProperty
Unknown.
  NiDynamicEffect
A dynamic effect such as a light or environment map.
  NiEnvMappedTriShape
Unknown
  NiEnvMappedTriShapeData
Holds mesh data using a list of singular triangles.
  NiExtraData
A generic extra data object.
  NiExtraDataController
An controller for extra data.
  NiFlipController
Texture flipping controller.
  NiFloatData
Possibly the 1D position along a 3D path.
  NiFloatExtraData
Float extra data.
  NiFloatExtraDataController
Unknown.
  NiFloatInterpController
A controller that interpolates floating point numbers?
  NiFloatInterpolator
Unknown.
  NiFloatsExtraData
Unknown.
  NiFogProperty
Describes...
  NiFurSpringController
  NiGeomMorpherController
Time controller for geometry morphing.
  NiGravity
A particle modifier; applies a gravitational field on the particles.
  NiImage
  NiInstancingMeshModifier
  NiIntegerExtraData
Extra integer data.
  NiIntegersExtraData
Integers data.
  NiInterpController
A controller capable of interpolation?
  NiInterpolator
Interpolator objects - function unknown.
  NiKeyBasedInterpolator
Interpolator objects that use keys?
  NiKeyframeController
A time controller object for animation key frames.
  NiLODData
Abstract class used for different types of LOD selections.
  NiLODNode
Level of detail selector.
  NiLight
Light source.
  NiLightColorController
Light color animation controller.
  NiLightDimmerController
Unknown controller.
  NiLightIntensityController
Unknown controller
  NiLines
Wireframe geometry.
  NiLinesData
Wireframe geometry data.
  NiLookAtController
Unknown.
  NiLookAtInterpolator
Unknown.
  NiMesh
  NiMeshHWInstance
  NiMeshModifier
Base class for mesh modifiers.
  NiMeshPSysData
Particle meshes data.
  NiMeshParticleSystem
Particle system.
  NiMorphController
Unknown! Used by Daoc->'healing.nif'.
  NiMorphMeshModifier
Performs linear-weighted blending between a set of target data streams.
  NiMorphWeightsController
  NiMorpherController
Unknown! Used by Daoc.
  NiMultiTargetTransformController
Unknown.
  NiMultiTextureProperty
(note: not quite complete yet...
  NiPSBombForce
  NiPSBoundUpdater
  NiPSBoxEmitter
  NiPSCylinderEmitter
  NiPSDragForce
  NiPSEmitParticlesCtlr
  NiPSEmitterDeclinationCtlr
  NiPSEmitterDeclinationVarCtlr
  NiPSEmitterLifeSpanCtlr
  NiPSEmitterPlanarAngleCtlr
  NiPSEmitterPlanarAngleVarCtlr
  NiPSEmitterRadiusCtlr
  NiPSEmitterRotAngleCtlr
  NiPSEmitterRotAngleVarCtlr
  NiPSEmitterRotSpeedCtlr
  NiPSEmitterRotSpeedVarCtlr
  NiPSEmitterSpeedCtlr
  NiPSFacingQuadGenerator
  NiPSForceActiveCtlr
  NiPSGravityForce
  NiPSGravityStrengthCtlr
  NiPSMeshEmitter
  NiPSMeshParticleSystem
  NiPSParticleSystem
  NiPSPlanarCollider
  NiPSResetOnLoopCtlr
  NiPSSimulator
The mesh modifier that performs all particle system simulation.
  NiPSSimulatorCollidersStep
Encapsulates a floodgate kernel that simulates particle colliders.
  NiPSSimulatorFinalStep
Encapsulates a floodgate kernel that updates particle positions and ages.
  NiPSSimulatorForcesStep
Encapsulates a floodgate kernel that simulates particle forces.
  NiPSSimulatorGeneralStep
Encapsulates a floodgate kernel that updates particle size, colors, and rotations.
  NiPSSimulatorMeshAlignStep
Encapsulates a floodgate kernel that updates mesh particle alignment and transforms.
  NiPSSimulatorStep
Abstract base class for a single step in the particle system simulation process.
  NiPSSpawner
  NiPSSphereEmitter
  NiPSSphericalCollider
  NiPSysAgeDeathModifier
Unknown particle modifier.
  NiPSysAirFieldAirFrictionCtlr
Particle system controller for air field air friction.
  NiPSysAirFieldInheritVelocityCtlr
Particle system controller for air field inherit velocity.
  NiPSysAirFieldModifier
Particle system modifier, used for controlling the particle velocity in a field like wind.
  NiPSysAirFieldSpreadCtlr
Particle system controller for air field spread.
  NiPSysBombModifier
Particle modifier that uses a NiNode to use as a "Bomb Object" to alter the path of particles.
  NiPSysBoundUpdateModifier
Unknown particle system modifier.
  NiPSysBoxEmitter
Particle emitter that uses points within a defined Box shape to emit from..
  NiPSysCollider
Particle system collider.
  NiPSysColliderManager
Particle modifier that adds a defined shape to act as a collision object for particles to interact with.
  NiPSysColorModifier
Particle modifier that adds keyframe data to modify color/alpha values of particles over time.
  NiPSysCylinderEmitter
Particle emitter that uses points within a defined Cylinder shape to emit from.
  NiPSysDragFieldModifier
Particle system modifier, used for controlling the particle velocity in drag space warp.
  NiPSysDragModifier
Unknown.
  NiPSysEmitter
A particle emitter?
  NiPSysEmitterCtlr
Particle system emitter controller.
  NiPSysEmitterCtlrData
Particle system emitter controller data.
  NiPSysEmitterDeclinationCtlr
Unknown.
  NiPSysEmitterDeclinationVarCtlr
Unknown.
  NiPSysEmitterInitialRadiusCtlr
Unknown.
  NiPSysEmitterLifeSpanCtlr
Unknown.
  NiPSysEmitterPlanarAngleCtlr
Particle system controller for emitter planar angle.
  NiPSysEmitterPlanarAngleVarCtlr
Particle system controller for emitter planar angle variation.
  NiPSysEmitterSpeedCtlr
Unknown.
  NiPSysFieldAttenuationCtlr
Particle system controller for force field attenuation.
  NiPSysFieldMagnitudeCtlr
Particle system controller for force field magnitude.
  NiPSysFieldMaxDistanceCtlr
Particle system controller for force field maximum distance.
  NiPSysFieldModifier
Base for all force field particle modifiers.
  NiPSysGravityFieldModifier
Particle system modifier, used for controlling the particle velocity in gravity field.
  NiPSysGravityModifier
Adds gravity to a particle system, when linked to a NiNode to use as a Gravity Object.
  NiPSysGravityStrengthCtlr
Unknown.
  NiPSysGrowFadeModifier
Particle modifier that controls the time it takes to grow a particle from Size=0 to the specified Size in the emitter, and then back to 0.
  NiPSysInitialRotAngleCtlr
Particle system controller for emitter initial rotation angle.
  NiPSysInitialRotAngleVarCtlr
Particle system controller for emitter initial rotation angle variation.
  NiPSysInitialRotSpeedCtlr
Particle system controller for emitter initial rotation speed.
  NiPSysInitialRotSpeedVarCtlr
Particle system controller for emitter initial rotation speed variation.
  NiPSysMeshEmitter
Particle emitter that uses points on a specified mesh to emit from.
  NiPSysMeshUpdateModifier
Unknown.
  NiPSysModifier
Generic particle system modifier object.
  NiPSysModifierActiveCtlr
Unknown.
  NiPSysModifierBoolCtlr
A particle system modifier controller that deals with boolean data?
  NiPSysModifierCtlr
A particle system modifier controller.
  NiPSysModifierFloatCtlr
A particle system modifier controller that deals with floating point data?
  NiPSysPlanarCollider
Particle Collider object which particles will interact with.
  NiPSysPositionModifier
Unknown particle system modifier.
  NiPSysRadialFieldModifier
Particle system modifier, used for controlling the particlevelocity in force field.
  NiPSysResetOnLoopCtlr
Unknown.
  NiPSysRotationModifier
Particle modifier that adds rotations to particles.
  NiPSysSpawnModifier
Unknown particle modifier.
  NiPSysSphereEmitter
Particle emitter that uses points within a sphere shape to emit from.
  NiPSysSphericalCollider
Particle Collider object which particles will interact with.
  NiPSysTrailEmitter
Guild 2-Specific node
  NiPSysTurbulenceFieldModifier
Particle system modifier, used for controlling the particle velocity in drag space warp.
  NiPSysUpdateCtlr
Particle system controller, used for ???.
  NiPSysVolumeEmitter
An emitter that emits meshes?
  NiPSysVortexFieldModifier
Particle system modifier, used for controlling the particle velocity in force field.
  NiPalette
A color palette.
  NiParticleBomb
A particle modifier.
  NiParticleColorModifier
Unknown.
  NiParticleGrowFade
This particle system modifier controls the particle size.
  NiParticleMeshModifier
Unknown.
  NiParticleMeshes
Mesh particle node?
  NiParticleMeshesData
Particle meshes data.
  NiParticleModifier
A particle system modifier.
  NiParticleRotation
Unknown.
  NiParticleSystem
A particle system.
  NiParticleSystemController
A generic particle system time controller object.
  NiParticles
Generic particle system node.
  NiParticlesData
Generic rotating particles data object.
  NiPathController
Time controller for a path.
  NiPathInterpolator
Unknown interpolator.
  NiPersistentSrcTextureRendererData
  NiPhysXActorDesc
Unknown PhysX node.
  NiPhysXBodyDesc
Unknown PhysX node.
  NiPhysXD6JointDesc
Unknown PhysX node.
  NiPhysXKinematicSrc
Unknown PhysX node.
  NiPhysXMaterialDesc
Unknown node.
  NiPhysXMeshDesc
Unknown PhysX node.
  NiPhysXProp
Unknown PhysX node.
  NiPhysXPropDesc
Unknown PhysX node.
  NiPhysXShapeDesc
Unknown PhysX node.
  NiPhysXTransformDest
Unknown PhysX node.
  NiPixelData
A texture.
  NiPlanarCollider
Unknown.
  NiPoint3InterpController
A controller that interpolates point 3 data?
  NiPoint3Interpolator
Unknown.
  NiPointLight
A point light.
  NiPortal
A Portal
  NiPosData
Position data.
  NiProperty
A generic property object.
  NiRangeLODData
Describes levels of detail based on distance of object from camera.
  NiRawImageData
Raw image data.
  NiRenderObject
An object that can be rendered.
  NiRollController
Unknown.
  NiRoom
Grouping node for nodes in a Portal
  NiRoomGroup
Grouping node for nodes in a Portal
  NiRotatingParticles
Unknown.
  NiRotatingParticlesData
Rotating particles data object.
  NiScreenElements
Two dimensional screen elements.
  NiScreenElementsData
Two dimensional screen elements.
  NiScreenLODData
Describes levels of detail based on size of object on screen?
  NiSequence
Root node used in some Empire Earth II .kf files (version 4.2.2.0).
  NiSequenceData
  NiSequenceStreamHelper
Keyframe animation root node, in .kf files.
  NiShadeProperty
Determines whether flat shading or smooth shading is used on a shape.
  NiShadowGenerator
  NiSingleInterpController
A controller referring to a single interpolator.
  NiSkinInstance
Skinning instance.
  NiSkinPartition
Skinning data, optimized for hardware skinning.
  NiSkinningLODController
  NiSkinningMeshModifier
  NiSortAdjustNode
Unknown node.
  NiSourceCubeMap
Unknown node.
  NiSourceTexture
Describes texture source and properties.
  NiSpecularProperty
Gives specularity to a shape.
  NiSphericalCollider
Unknown.
  NiSpotLight
A spot.
  NiStencilProperty
Allows control of stencil testing.
  NiStringExtraData
Apparently commands for an optimizer instructing it to keep things it would normally discard.Also refers to NiNode objects (through their name) in animation .kf files.
  NiStringPalette
List of 0x00-seperated strings, which are names of controlled objects and controller types.
  NiStringsExtraData
List of strings; for example, a list of all bone names.
  NiSwitchNode
A node used to switch between branches, such as for LOD levels?
  NiTextKeyExtraData
Extra data, used to name different animation sequences.
  NiTexture
A texture.
  NiTextureEffect
Enables environment mapping.
  NiTextureModeProperty
Unknown
  NiTextureProperty
  NiTextureTransformController
Texture transformation controller.
  NiTexturingProperty
Describes an object's textures.
  NiTimeController
A generic time controller object.
  NiTransformController
NiTransformController replaces the NiKeyframeController.
  NiTransformData
Mesh animation keyframe data.
  NiTransformEvaluator
  NiTransparentProperty
Unknown
  NiTriShape
A shape node that refers to singular triangle data.
  NiTriShapeSkinController
Old version of skinning instance.
  NiTriStrips
A shape node that refers to data organized into strips of triangles
  NiUVController
Time controller for texture coordinates.
  NiUVData
Texture coordinate data.
  NiVectorExtraData
Extra vector data.
  NiVertWeightsExtraData
Not used in skinning.Unsure of use - perhaps for morphing animation or gravity.
  NiVertexColorProperty
Property of vertex colors.
  NiVisController
Time controller for visibility.
  NiVisData
Visibility data for a controller.
  NiWireframeProperty
Unknown.
  NiZBufferProperty
This Property controls the Z buffer (OpenGL: depth buffer).
  NodeGroup
A group of NiNodes references.
  OblivionColFilter
Oblivion's ColFilter property for Havok.
  OblivionLayer
Sets mesh color in Oblivion Construction Set.
  OblivionSubShape
Havok Information for packed TriStrip shapes.
  OldSkinData
Used to store skin weights in NiTriShapeSkinController.
  PSLoopBehavior
  Particle
particle array entry
  ParticleDesc
Particle Description.
  PixelFormat
Specifies the pixel format used by the NiPixelData object to store a texture.
  PixelLayout
An unsigned 32-bit integer, describing the color depth of a texture.
  Polygon
Two dimensional screen elements.
  PropagationMode
  QuatKey
A special version of the key type used for quaternions.
  Quaternion
A quaternion.
  QuaternionXYZW
A quaternion as it appears in the havok objects.
  Region
A range of indices, which make up a region (such as a submesh).
  RootCollisionNode
Morrowind-specific node for collision mesh.
  SemanticData
  ShaderTexDesc
An extended texture description for shader textures.
  SkinShape
Reference to shape and skin instance.
  SkinShapeGroup
Unknown.
  SkinTransform
  SkinWeight
A weighted vertex.
  SkyShaderProperty
Bethesda-specific node? Found in Fallout3
  SolverDeactivation
A list of possible solver deactivation settings.
  SortingMode
  SphereBV
A sphere.
  StencilAction
This enum defines the various actions used in conjunction with the stencil buffer.For a detailed description of the individual options please refer to the OpenGL docs.
  StencilCompareMode
This enum contains the options for doing stencil buffer tests.
  SymmetryType
Determines symetry type used by NiPSysBombModifier.
  SyncPoint
Specifies the time when an application must syncronize for some reason.
  TBC
Tension, bias, continuity.
  TallGrassShaderProperty
Bethesda-specific node.
  TargetColor
Used by NiPoint3InterpControllers to select which type of color in the controlled object that will be animated.
  TexClampMode
Specifies the availiable texture clamp modes.
  TexDesc
Texture description.
  TexFilterMode
Specifies the availiable texture filter modes.
  TexSource
A texture source.
  TexTransform
Determines how a NiTextureTransformController animates the UV coordinates.
  TexType
The type of texture.
  TileShaderProperty
Bethesda-specific node.
  Triangle
List of three vertex indices.
  UnionBV
  VelocityType
Controls the way the a particle mesh emitter determines the starting speed and direction of the particles that are emitted.
  VertMode
An unsigned 32-bit integer, which describes how to apply vertex colors.
  VolumetricFogShaderProperty
Bethesda-specific node.
  WaterShaderProperty
Bethesda-specific node? Found in Fallout3
  ZCompareMode
This enum contains the options for doing z buffer tests.
  _ATextureRenderData
  _BSBound
Bethesda-specific collision bounding box for skeletons.
  _BSDismemberSkinInstance
Bethesda-specific node.
  _ControllerLink
In a .kf file, this links to a controllable object, via its name (or for version 10.2.0.0 and up, a link and offset to a NiStringPalette that contains the name), and a sequence of interpolators that apply to this controllable object, via links.
  _Footer
The NIF file footer.
  _Header
The NIF file header.
  _InertiaMatrix
An inertia matrix.
  _LimitedHingeDescriptor
  _Matrix33
A 3x3 rotation matrix; M^T M=identity, det(M)=1.
  _Matrix44
A 4x4 transformation matrix.
  _NiAVObject
Generic node object.
  _NiBSplineCompTransformInterpolator
An interpolator for storing transform keyframes via a compressedB-spline (that is, using shorts rather than floats in the B-splinedata).
  _NiBSplineData
B-spline data points as floats, or as shorts for compressed B-splines.
  _NiBSplineInterpolator
For interpolators storing data via a B-spline.
  _NiBSplineTransformInterpolator
An interpolator for storing transform keyframes via a B-spline.
  _NiControllerSequence
Root node in .kf files (version 10.0.1.0 and up).
  _NiGeometry
Describes a visible scene element with vertices like a mesh, a particle system, lines, etc.
  _NiGeometryData
Mesh data: vertices, vertex normals, etc.
  _NiKeyframeData
Keyframes for mesh animation.
  _NiMaterialColorController
Time controller for material color.
  _NiMaterialProperty
Describes the material shading properties.
  _NiMorphData
Geometry morphing data.
  _NiNode
Generic node object for grouping.
  _NiObject
Abstract object type.
  _NiObjectNET
An object that can be controlled by a controller.
  _NiPSysData
Particle system data.
  _NiSkinData
Skinning data.
  _NiTransformInterpolator
An interpolator for transform keyframes.
  _NiTriBasedGeom
Describes a mesh, built from triangles.
  _NiTriBasedGeomData
Describes a mesh, built from triangles.
  _NiTriShapeData
Holds mesh data using a list of singular triangles.
  _NiTriStripsData
Holds mesh data using strips of triangles.
  _RagdollDescriptor
This constraint defines a cone in which an object can rotate.
  _SkinData
Skinning data component.
  _SkinPartition
Skinning data for a submesh, optimized for hardware skinning.
  _StringPalette
A list of \0 terminated strings.
  _TexCoord
Texture coordinates (u,v).
  _Vector3
A vector in 3D space (x,y,z).
  _Vector4
A 4-dimensional vector.
  _bhkBoxShape
A box.
  _bhkCapsuleShape
A capsule.
  _bhkConstraint
Describes a physical constraint.
  _bhkConvexVerticesShape
A convex shape built from vertices.
  _bhkLimitedHingeConstraint
Hinge constraint.
  _bhkListShape
A list of shapes.Do not put a bhkPackedNiTriStripsShape in the Sub Shapes.
  _bhkMalleableConstraint
A malleable constraint.
  _bhkMoppBvTreeShape
Memory optimized partial polytope bounding volume tree shape (not an entity).
  _bhkMultiSphereShape
Unknown.
  _bhkNiTriStripsShape
A shape constructed from a bunch of strips.
  _bhkPackedNiTriStripsShape
A shape constructed from strips data.
  _bhkRagdollConstraint
Ragdoll constraint.
  _bhkRefObject
The base type of most Bethesda-specific Havok-related NIF objects.
  _bhkRigidBody
This is the default body type for all "normal" usable and static world objects.
  _bhkSphereShape
A sphere.
  _bhkTransformShape
Transforms a shape.
  _hkPackedNiTriStripsData
NiTriStripsData for havok data?
  bhkAabbPhantom
Bethesda-specific node.
  bhkBlendCollisionObject
Unknown.
  bhkBlendController
Unknown.
  bhkBreakableConstraint
Bethesda-Specific node.
  bhkBvTreeShape
A tree-like Havok data structure stored in an assembly-like binary code?
  bhkCollisionObject
Havok related collision object?
  bhkConvexListShape
A havok shape.A list of shapes.Do not put a bhkPackedNiTriStripsShape in the Sub Shapes.
  bhkConvexShape
A havok shape.
  bhkConvexTransformShape
A convex transformed shape?
  bhkEntity
A havok node, describes physical properties.
  bhkHingeConstraint
A hinge constraint.
  bhkLiquidAction
Bethesda-specific node.
  bhkMeshShape
  bhkNiCollisionObject
Havok related collision object?
  bhkOrientHingedBodyAction
Bethesda-Specific node.
  bhkPCollisionObject
Unknown.
  bhkPhantom
Havok object that do not react with other objects when they collide (causing deflection, etc.) but still trigger collision notifications to the game.
  bhkPrismaticConstraint
A prismatic constraint.
  bhkRigidBodyT
Unknown.
  bhkSPCollisionObject
Unknown.
  bhkSerializable
Havok objects that can be saved and loaded from disk?
  bhkShape
A Havok Shape?
  bhkShapeCollection
Havok collision object that uses multiple shapes?
  bhkShapePhantom
A Havok phantom that uses a Havok shape object for its collision volume instead of just a bounding box.
  bhkSimpleShapePhantom
Unknown shape.
  bhkSphereRepShape
A havok shape, perhaps with a bounding sphere for quick rejection in addition to more detailed shape data?
  bhkStiffSpringConstraint
A spring constraint.
  bhkWorldObject
Havok objects that have a position in the world?
  hkResponseType
  hkTriangle
A triangle with extra data used for physics.
  physXMaterialRef

Inherited from object_models.xml.FileFormat: __metaclass__

Instance Methods [hide private]

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods [hide private]
 
vercondFilter(cls, expression) source code

Inherited from object_models.FileFormat: name_attribute, name_class, name_parts, walk, walkData

Static Methods [hide private]
 
version_number(version_str)
Converts version string into an integer.
source code
Class Variables [hide private]
  xml_file_name = 'nif.xml'
Override.
  xml_file_path = [None, '/usr/lib/python2.7/site-packages/pyffi...
Override.
  RE_FILENAME = re.compile(r'(?i)^.*\.(nif|kf|kfa|nifcache|jmi|t...
Override this with a regular expression (the result of a re.compile call) for the file extension of the format you are implementing.
  ARCHIVE_CLASSES = [<class 'pyffi.formats.bsa.BsaFormat'>]
Override this with a list of archive formats that may contain files of the format.
  EPSILON = 0.0001
  games = {'?': [167772419], 'Atlantica': [335675400], 'Axis and...
  versions = {'10.0.1.0': 167772416, '10.0.1.2': 167772418, '10....
  xml_bit_struct = [<class 'pyffi.formats.nif.BSPartFlag'>, <cla...
  xml_enum = [<class 'pyffi.formats.nif.AlphaFormat'>, <class 'p...
  xml_struct = [<class 'pyffi.formats.nif.Color3'>, <class 'pyff...

Inherited from object_models.xml.FileFormat: logger, xml_alias

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

vercondFilter(cls, expression)
Class Method

source code 
Overrides: object_models.xml.FileFormat.vercondFilter

version_number(version_str)
Static Method

source code 

Converts version string into an integer.

>>> hex(NifFormat.version_number('3.14.15.29'))
'0x30e0f1d'
>>> hex(NifFormat.version_number('1.2'))
'0x1020000'
>>> hex(NifFormat.version_number('3.03'))
'0x3000300'
>>> hex(NifFormat.version_number('NS'))
'0xa010000'
Parameters:
  • version_str (str) - The version string.
Returns:
A version integer.
Overrides: object_models.FileFormat.version_number

Class Variable Details [hide private]

xml_file_path

Override.
Value:
[None, '/usr/lib/python2.7/site-packages/pyffi/formats/nif/nifxml']

RE_FILENAME

Override this with a regular expression (the result of a re.compile call) for the file extension of the format you are implementing.
Value:
re.compile(r'(?i)^.*\.(nif|kf|kfa|nifcache|jmi|texcache|pcpatch|nft|it\
em|nif_wii)$')

games

Value:
{'?': [167772419],
 'Atlantica': [335675400],
 'Axis and Allies': [167837696],
 'Bully SE': [335740937],
 'Civilization IV': [67239938,
                     67240192,
                     67240448,
                     167772416,
...

versions

Value:
{'10.0.1.0': 167772416,
 '10.0.1.2': 167772418,
 '10.0.1.3': 167772419,
 '10.1.0.0': 167837696,
 '10.1.0.101': 167837797,
 '10.1.0.106': 167837802,
 '10.2.0.0': 167903232,
 '10.2.0.1': 167903233,
...

xml_bit_struct

Value:
[<class 'pyffi.formats.nif.BSPartFlag'>,
 <class 'pyffi.formats.nif.BSShaderFlags'>,
 <class 'pyffi.formats.nif.DataStreamAccess'>]

xml_enum

Value:
[<class 'pyffi.formats.nif.AlphaFormat'>,
 <class 'pyffi.formats.nif.ApplyMode'>,
 <class 'pyffi.formats.nif.TexType'>,
 <class 'pyffi.formats.nif.KeyType'>,
 <class 'pyffi.formats.nif.LightMode'>,
 <class 'pyffi.formats.nif.HavokMaterial'>,
 <class 'pyffi.formats.nif.OblivionLayer'>,
 <class 'pyffi.formats.nif.MipMapFormat'>,
...

xml_struct

Value:
[<class 'pyffi.formats.nif.Color3'>,
 <class 'pyffi.formats.nif.ByteColor3'>,
 <class 'pyffi.formats.nif.Color4'>,
 <class 'pyffi.formats.nif.ByteColor4'>,
 <class 'pyffi.formats.nif._Footer'>,
 <class 'pyffi.formats.nif.LODRange'>,
 <class 'pyffi.formats.nif.MatchGroup'>,
 <class 'pyffi.formats.nif._Vector3'>,
...