View source for ModelPart Indexing

{{Notice/Warning|content=This page is a draft, and is not complete.}}

When Figura loads your avatar, all the model files in your avatar are organized into a tree. The starting point of this tree is called <code>models</code>. All of the parts of your model, including cubes, meshes, and groups from your Blockbench models, as well as folders in your avatar and the model files themselves are converted to ModelParts and part of this tree.

The name <code>models</code> does not refer to any specific model file in your avatar. Instead, model files are created as children of the <code>models</code> folder. '''If your Blockbench model is inside a subfolder of your avatar''', that folder becomes a child of <code>models</code>, and the model file becomes a child of the subfolder.

{{tree|icon=BBModel.png|content=<code>model.bbmodel</code>|inner=
{{tree|icon=BBGroup.png|content=root|inner=
{{tree|icon=BBGroup.png|content=Head|inner=
{{tree|icon=BBCube.png|content=Head}}
{{tree|icon=BBCube.png|content=HeadLayer}}
}}
{{tree|icon=BBGroup.png|content=RightArm|inner=
{{tree|icon=BBCube.png|content=RightArm}}
{{tree|icon=BBCube.png|content=RightArmLayer}}
}}
{{tree|icon=BBCube.png|content=Cool Name}}
}}
}}

To access a child part, ''index'' the parent part with the name of the child part.

There are two ways to ''index'' something in Lua. The first way is by using brackets and quotes:

<syntaxhighlight lang="lua">
models["model"]["Head"]
</syntaxhighlight>

This code sample first gets the <code>model</code> part (a file named <code>model.bbmodel</code>) and then the <code>Head</code> group inside it. The name of the cube, mesh, group, folder, or file needs to be within the quotes. To access deeper parts (for example, a <code>Hat</code> cube within the <code>Head</code> group), add more indexing:

<syntaxhighlight lang="lua">
models["model"]["Head"]["Hat"]
</syntaxhighlight>

The second way to index is shorter, and uses a <code>.</code> to separate the names.

{{Notice/Warning|content=This method only works '''if the name consists only of letters, numbers, and underscores''' and the first character isn't a number. If the name of a ModelPart contains characters not in that list, or if the name contains any spaces, you ''must'' use the first method to index that name.}}

For example, the following is equivalent to the code above for getting the <code>Hat</code> ModelPart.

<syntaxhighlight lang="lua">
models.model.Head.Hat
</syntaxhighlight>