bw logo

Chapter 23. modules.xml

Used by client tools World Editor, Model Editor, and Particle Editor, and located under bigworld/tools/<tool_folder>/resources/data, this file is used to determine which modules should be run for the tool.

Its grammar is listed below:

<root>

  <startup>
    *<module>    string  </module>
  </startup>

  <Bases>
    *<section>   string  </section>
  </Bases>

  <Extensions>
    *<ext_name>  
      [ ScriptedModule
        <script>
          <module> string  </module>
          <class>  string  </class>
        </script>
      |
        module_name
      ]
  </Extensions>

</root>

Grammar of <tool_folder>/resources/data/modules.xml

The list below describes the tags in bigworld/tools/<tool_folder>/resources/data/modules.xml:

  • class (section Extensions/ext_name/ ScriptedModule/script)

    Name of the Python class to use for this module.

  • Extensions

    Section containing all modules that can be used by the application.

  • ext_name (section Extensions)

    Section containing information for the module.

  • module (section startup)

    • Section startup

      Module to use on startup of the application.

      This tag is one of the ext_name tags in Extensions section.

    • Section Extensions/ext_name/ ScriptedModule/script

      Name (without extension) of the Python file to use for this module.

      It is expected that the class specified in class tag is located in this file.

  • module_name (section Extensions/ext_name)

    Name of the module to use (referred to in startup/module tag)

  • script (section Extensions/ext_name/ ScriptedModule)

    Description of the Python class to use for this module.

  • ScriptedModule (section Extensions/ext_name)

    Used to denote that the description following it is for a Python script.