pyffi :: spells :: nif :: modify :: SpellChangeAllBonePriorities :: Class SpellChangeAllBonePriorities
[hide private]
[frames] | no frames]

Class SpellChangeAllBonePriorities

source code

       object --+            
                |            
            Spell --+        
                    |        
             NifSpell --+    
                        |    
SpellChangeBonePriorities --+
                            |
                           SpellChangeAllBonePriorities

Changes all controlled block priorities to supplied argument.
Instance Methods [hide private]
bool
branchentry(self, branch)
Cast the spell on the given branch.
source code

Inherited from SpellChangeBonePriorities: branchinspect, datainspect

Inherited from NifSpell: inspectblocktype

Inherited from NifSpell (private): _datainspect

Inherited from Spell: __init__, branchexit, dataentry, dataexit, recurse

Inherited from Spell (private): _branchinspect

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

Class Methods [hide private]
bool
toastentry(cls, toaster)
Called just before the toaster starts processing all files.
source code

Inherited from Spell: get_toast_stream, toastexit

Class Variables [hide private]
  SPELLNAME = 'modify_allbonepriorities'
A str describing how to refer to the spell from the command line.

Inherited from SpellChangeBonePriorities: READONLY

Inherited from Spell: changed, data, stream, toaster

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

toastentry(cls, toaster)
Class Method

source code 

Called just before the toaster starts processing all files. If it returns False, then the spell is not used. The default implementation simply returns True.

For example, if the spell only acts on a particular block type, but that block type is excluded, then you can use this function to flag that this spell can be skipped. You can also use this function to initialize statistics data to be aggregated from files, to initialize a log file, and so.

Parameters:
  • toaster - The toaster this spell is called from.
Returns: bool
True if the spell applies, False otherwise.
Overrides: Spell.toastentry
(inherited documentation)

branchentry(self, branch)

source code 

Cast the spell on the given branch. First called with branch equal to data's children, then the grandchildren, and so on. The default implementation simply returns True.

Typically, you will override this function to perform an operation on a particular block type and/or to stop recursion at particular block types.

Parameters:
  • branch - The branch to cast the spell on.
Returns: bool
True if the children must be processed, False otherwise.
Overrides: Spell.branchentry
(inherited documentation)