Home       Trees       Indices       Help   
   Python File Format Interface      SourceForge.net Logo   
Package pyffi :: Package formats :: Package nif :: Class NifFormat :: Class _Header
[hide private]
[frames] | no frames]

Class _Header

source code

                  object --+            
                           |            
      utils.graph.DetailNode --+        
                               |        
          utils.graph.GlobalNode --+    
                                   |    
object_models.xml.struct_.StructBase --+
                                       |
                                      NifFormat._Header
Known Subclasses:
The NIF file header.
Nested Classes [hide private]

Inherited from object_models.xml.struct_.StructBase: __metaclass__

Instance Methods [hide private]

Inherited from object_models.xml.struct_.StructBase: __init__, __str__, deepcopy, fix_links, get_attribute, get_basic_attribute, get_detail_child_names, get_detail_child_nodes, get_global_child_nodes, get_global_display, get_hash, get_links, get_refs, get_size, get_strings, get_template_attribute, read, replace_global_node, set_attribute, set_basic_attribute, set_template_attribute, tree, write

Inherited from object_models.xml.struct_.StructBase (private): _get_filtered_attribute_list

Inherited from utils.graph.GlobalNode: get_global_child_edge_types, get_global_iterator

Inherited from utils.graph.DetailNode: get_detail_child_edge_types, get_detail_display, get_detail_iterator

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

Class Methods [hide private]

Inherited from object_models.xml.struct_.StructBase: get_games, get_versions

Inherited from object_models.xml.struct_.StructBase (private): _get_attribute_list, _get_names

Class Variables [hide private]
  _attribute_list = [<pyffi.object_models.xml.StructAttribute ob...
  _attrs = [<pyffi.object_models.xml.StructAttribute object at 0...
  _names = ['header_string', 'copyright', 'version', 'endian_typ...

Inherited from object_models.xml.struct_.StructBase: arg

Inherited from object_models.xml.struct_.StructBase (private): _games, _has_links, _has_refs, _has_strings, _is_template

Properties [hide private]
  block_size
Array of block sizes?
  block_type_index
Maps file objects on their corresponding type: first file object is of type object_types[object_type_index[0]], the second of object_types[object_type_index[1]], etc.
  block_types
List of all object types used in this NIF file.
  copyright
  endian_type
Determines the endianness of the data in the file.
  export_info
  header_string
'NetImmerse File Format x.x.x.x'(versions<= 10.0.1.2) or'Gamebryo File Format x.x.x.x'(versions>= 10.1.0.0), with x.x.x.x the version written out.
  max_string_length
Maximum string length.
  num_block_types
Number of object types in this NIF file.
  num_blocks
Number of file objects.
  num_strings
Number of strings.
  strings
Strings.
  unknown_int_2
Unknown.
  unknown_int_3
Unknown.
  user_version
An extra version number, for companies that decide to modify the file format.
  user_version_2
This also appears to be the extra user version number and must be set in some circumstances.
  version
The NIF version, in hexadecimal notation: 0x04000002, 0x0401000C, 0x04020002, 0x04020100, 0x04020200, 0x0A000100, 0x0A010000, 0x0A020000, 0x14000004, ...

Inherited from object: __class__

Class Variable Details [hide private]

_attribute_list

Value:
[<pyffi.object_models.xml.StructAttribute object at 0x2c20090>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c20110>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c20190>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c201d0>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c20210>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c20250>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c20310>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c20390>,
...

_attrs

Value:
[<pyffi.object_models.xml.StructAttribute object at 0x2c20090>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c20110>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c20190>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c201d0>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c20210>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c20250>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c20310>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c20390>,
...

_names

Value:
['header_string',
 'copyright',
 'version',
 'endian_type',
 'user_version',
 'num_blocks',
 'user_version_2',
 'unknown_int_3',
...

Property Details [hide private]

block_size

Array of block sizes?
Get Method:
<functools.partial object at 0x2c266d8>

block_type_index

Maps file objects on their corresponding type: first file object is of type object_types[object_type_index[0]], the second of object_types[object_type_index[1]], etc.
Get Method:
<functools.partial object at 0x2c26628>

block_types

List of all object types used in this NIF file.
Get Method:
<functools.partial object at 0x2c26578>

copyright

Get Method:
<functools.partial object at 0x2c1ec58>

endian_type

Determines the endianness of the data in the file.
Get Method:
<functools.partial object at 0x2c1ee10>
Set Method:
<functools.partial object at 0x2c1ee68>

export_info

Get Method:
<functools.partial object at 0x2c26470>
Set Method:
<functools.partial object at 0x2c264c8>

header_string

'NetImmerse File Format x.x.x.x'(versions<= 10.0.1.2) or'Gamebryo File Format x.x.x.x'(versions>= 10.1.0.0), with x.x.x.x the version written out. Ends with a newline character (0x0A).
Get Method:
<functools.partial object at 0x2c1eb50>
Set Method:
<functools.partial object at 0x2c1eba8>

max_string_length

Maximum string length.
Get Method:
<functools.partial object at 0x2c26890>
Set Method:
<functools.partial object at 0x2c268e8>

num_block_types

Number of object types in this NIF file.
Get Method:
<functools.partial object at 0x2c26418>
Set Method:
<functools.partial object at 0x2c263c0>

num_blocks

Number of file objects.
Get Method:
<functools.partial object at 0x2c26050>
Set Method:
<functools.partial object at 0x2c260a8>

num_strings

Number of strings.
Get Method:
<functools.partial object at 0x2c26788>
Set Method:
<functools.partial object at 0x2c267e0>

strings

Strings.
Get Method:
<functools.partial object at 0x2c26998>

unknown_int_2

Unknown.
Get Method:
<functools.partial object at 0x2c26a48>
Set Method:
<functools.partial object at 0x2c26aa0>

unknown_int_3

Unknown. Possibly User Version 2?
Get Method:
<functools.partial object at 0x2c26260>
Set Method:
<functools.partial object at 0x2c262b8>

user_version

An extra version number, for companies that decide to modify the file format.
Get Method:
<functools.partial object at 0x2c1ef18>
Set Method:
<functools.partial object at 0x2c1ef70>

user_version_2

This also appears to be the extra user version number and must be set in some circumstances. Probably used by Bethesda to denote the Havok version.
Get Method:
<functools.partial object at 0x2c26158>
Set Method:
<functools.partial object at 0x2c261b0>

version

The NIF version, in hexadecimal notation: 0x04000002, 0x0401000C, 0x04020002, 0x04020100, 0x04020200, 0x0A000100, 0x0A010000, 0x0A020000, 0x14000004, ...
Get Method:
<functools.partial object at 0x2c1ed08>
Set Method:
<functools.partial object at 0x2c1ed60>

   Home       Trees       Indices       Help   
   Python File Format Interface      SourceForge.net Logo   
Generated by Epydoc 3.0.1 on Mon Oct 10 19:03:51 2011 http://epydoc.sourceforge.net