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

Class _ControllerLink

source code

                  object --+            
                           |            
      utils.graph.DetailNode --+        
                               |        
          utils.graph.GlobalNode --+    
                                   |    
object_models.xml.struct_.StructBase --+
                                       |
                                      NifFormat._ControllerLink
Known Subclasses:

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.
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 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

Class Variables [hide private]
  _attribute_list = [<pyffi.object_models.xml.StructAttribute ob...
  _attrs = [<pyffi.object_models.xml.StructAttribute object at 0...
  _has_links = True
  _has_refs = True
  _has_strings = True
  _names = ['target_name', 'controller', 'interpolator', 'unknow...

Inherited from object_models.xml.struct_.StructBase: arg

Properties [hide private]
  controller
Unknown link.
  controller_type
Probably the object type name of the controller in the NIF file that is child of the controlled object.
  controller_type_offset
Apparently the offset in the string palette of some type of controller related to Interpolator (for example, a'NiTransformInterpolator'will have here a'NiTransformController', etc.).
  interpolator
Link to an interpolator.
  node_name
The name of the animated node.
  node_name_offset
Offset in the string palette where the name of the controlled node (NiNode, NiTriShape, ...) starts.
  priority
Idle animations tend to have low values for this, and NIF objects that have high values tend to correspond with the important parts of the animation.
  property_type
Name of the property (NiMaterialProperty, ...), if this controller controls a property.
  property_type_offset
Offset in the string palette where the property (NiMaterialProperty, ...) starts, if this controller controls a property.
  string_palette
Refers to the NiStringPalette which contains the name of the controlled NIF object.
  target_name
Name of a controllable object in another NIF file.
  unknown_link_2
Unknown.
  unknown_short_0
Unknown.
  variable_1
Some variable string (such as'SELF_ILLUM','0-0-TT_TRANSLATE_U','tongue_out', etc.).
  variable_1_offset
Offset in the string palette where some variable string starts (such as'SELF_ILLUM','0-0-TT_TRANSLATE_U','tongue_out', etc.).
  variable_2
Another variable string, apparently used for particle system controllers.
  variable_2_offset
Offset in the string palette where some variable string starts (so far only'EmitterActive'and'BirthRate'have been observed in official files, used for particle system controllers).

Inherited from object: __class__

Class Variable Details [hide private]

_attribute_list

Value:
[<pyffi.object_models.xml.StructAttribute object at 0x2c18510>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c18590>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c18650>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c186d0>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c18790>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c18810>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c18850>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c189d0>,
...

_attrs

Value:
[<pyffi.object_models.xml.StructAttribute object at 0x2c18510>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c18590>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c18650>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c186d0>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c18790>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c18810>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c18850>,
 <pyffi.object_models.xml.StructAttribute object at 0x2c189d0>,
...

_names

Value:
['target_name',
 'controller',
 'interpolator',
 'unknown_link_2',
 'unknown_short_0',
 'priority',
 'string_palette',
 'node_name',
...

Property Details [hide private]

controller

Unknown link. Usually -1.
Get Method:
<functools.partial object at 0x2c1a680>
Set Method:
<functools.partial object at 0x2c1a6d8>

controller_type

Probably the object type name of the controller in the NIF file that is child of the controlled object.
Get Method:
<functools.partial object at 0x2c1afc8>
Set Method:
<functools.partial object at 0x2c1e050>

controller_type_offset

Apparently the offset in the string palette of some type of controller related to Interpolator (for example, a'NiTransformInterpolator'will have here a'NiTransformController', etc.). Sometimes the type of controller that links to the interpolator. Probably it refers to the controller in the NIF file that is child of the controlled object, via its type name.
Get Method:
<functools.partial object at 0x2c1af70>
Set Method:
<functools.partial object at 0x2c1af18>

interpolator

Link to an interpolator.
Get Method:
<functools.partial object at 0x2c1a578>
Set Method:
<functools.partial object at 0x2c1a5d0>

node_name

The name of the animated node.
Get Method:
<functools.partial object at 0x2c1aba8>
Set Method:
<functools.partial object at 0x2c1ac00>

node_name_offset

Offset in the string palette where the name of the controlled node (NiNode, NiTriShape, ...) starts.
Get Method:
<functools.partial object at 0x2c1ab50>
Set Method:
<functools.partial object at 0x2c1aaf8>

priority

Idle animations tend to have low values for this, and NIF objects that have high values tend to correspond with the important parts of the animation.
Get Method:
<functools.partial object at 0x2c1a890>
Set Method:
<functools.partial object at 0x2c1a8e8>

property_type

Name of the property (NiMaterialProperty, ...), if this controller controls a property.
Get Method:
<functools.partial object at 0x2c1adb8>
Set Method:
<functools.partial object at 0x2c1ae10>

property_type_offset

Offset in the string palette where the property (NiMaterialProperty, ...) starts, if this controller controls a property. Otherwise, -1.
Get Method:
<functools.partial object at 0x2c1ad60>
Set Method:
<functools.partial object at 0x2c1ad08>

string_palette

Refers to the NiStringPalette which contains the name of the controlled NIF object.
Get Method:
<functools.partial object at 0x2c1a998>
Set Method:
<functools.partial object at 0x2c1a9f0>

target_name

Name of a controllable object in another NIF file.
Get Method:
<functools.partial object at 0x2c1a368>
Set Method:
<functools.partial object at 0x2c1a3c0>

unknown_link_2

Unknown.
Get Method:
<functools.partial object at 0x2c1a520>
Set Method:
<functools.partial object at 0x2c1a4c8>

unknown_short_0

Unknown.
Get Method:
<functools.partial object at 0x2c1a788>
Set Method:
<functools.partial object at 0x2c1a7e0>

variable_1

Some variable string (such as'SELF_ILLUM','0-0-TT_TRANSLATE_U','tongue_out', etc.).
Get Method:
<functools.partial object at 0x2c1e208>
Set Method:
<functools.partial object at 0x2c1e260>

variable_1_offset

Offset in the string palette where some variable string starts (such as'SELF_ILLUM','0-0-TT_TRANSLATE_U','tongue_out', etc.). Usually, -1.
Get Method:
<functools.partial object at 0x2c1e1b0>
Set Method:
<functools.partial object at 0x2c1e158>

variable_2

Another variable string, apparently used for particle system controllers.
Get Method:
<functools.partial object at 0x2c1e418>
Set Method:
<functools.partial object at 0x2c1e470>

variable_2_offset

Offset in the string palette where some variable string starts (so far only'EmitterActive'and'BirthRate'have been observed in official files, used for particle system controllers). Usually, -1.
Get Method:
<functools.partial object at 0x2c1e3c0>
Set Method:
<functools.partial object at 0x2c1e368>