< Previous | Contents | Next >

Conventions

image

Note

Read the Introduction chapters before continuing with the guide.

Important notes will be featured in text boxes like this:



Code is introduced in boxes with a monospaced font like this:

print(“Hello World from Fusion!”) -- Writes text to the console


Regular text may refer to code statements inline, which is also represented by a monospaced font, e.g., the statement ‘print’ in this sentence:

The statement print writes text to the console.


Most examples shown in the guide are only excerpts of the full source code and may not be able to work on their own. This helps to make the guide more readable. However, all passages marked as Tutorial will contain full source code.

Most code examples are shown in Lua. Inline statements show the Lua implementation of the particular statement; as with Lua, it is easier to identify properties and methods. In order to not mix up Lua tuples with Python tuples, the generic term collection is used to describe tuples, list, dictionaries, etc.

The code here is written for teaching purposes. Sometimes things that could be refactored into separate methods are written explicitly or in a non-optimized way. Please do not hesitate to add your own talent to the code after the fundamental concepts of the API are known.

For consistency reasons naming convention follows roughly the naming of the API (cameCase) for both Lua and Python. Feel free to adapt to PEP8 or your own convention instead.


Scripting Guide