ModelPart Indexing - Revision history

PenguinEncounter: how did i miss that what

2025-04-12T23:58:46Z

how did i miss that what

← Older revision		Revision as of 23:58, 12 April 2025
Line 30:		Line 30:
	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>HeadLayer</code> cube within the <code>Head</code> group), add more dots and names:		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>HeadLayer</code> cube within the <code>Head</code> group), add more dots and names:

	<div style="padding: 4px 6px; border-radius: 6px; border: 3px solid var(--color-success); width: fit-content; margin-top: 6px;"><code>models.model.root.HeadLayer</code></div>		<div style="padding: 4px 6px; border-radius: 6px; border: 3px solid var(--color-success); width: fit-content; margin-top: 6px;"><code>models.model.root.Head.HeadLayer</code></div>

	The second way to index is longer, and uses square brackets and quotes (<code>[""]</code>) to separate the names. '''This method is required if the name of a part contains characters that aren't letters, numbers, or underscores'''; this includes ''names with spaces'', like <code>Right Arm</code>.		The second way to index is longer, and uses square brackets and quotes (<code>[""]</code>) to separate the names. '''This method is required if the name of a part contains characters that aren't letters, numbers, or underscores'''; this includes ''names with spaces'', like <code>Right Arm</code>.

PenguinEncounter: new tutorial i guess

2025-03-27T05:40:18Z

new tutorial i guess

← Older revision		Revision as of 05:40, 27 March 2025
Line 16:		Line 16:
	}}		}}
	{{tree\|icon=BBCube.png\|content=Cool Name}}		{{tree\|icon=BBCube.png\|content=Cool Name}}
			{{tree\|icon=BBGroup.png\|content=Cool Group\|inner=
			{{tree\|icon=BBCube.png\|content=cube}}
			}}
	}}		}}
	}}		}}
Line 21:		Line 24:
	To access a child part, ''index'' the parent part with the name of the child part.		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~~:		There are two ways to ''index'' something in Lua. The first way is by using dots:

	~~<syntaxhighlight lang="lua">~~
	~~models["model"]["root"]["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>HeadLayer</code> cube within the <code>Head</code> group), add more indexing:

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

	~~The second way to index is shorter, and uses a~~ <code>.</code> ~~to separate the names.~~		<div style="padding: 4px 6px; border-radius: 6px; border: 3px solid var(--color-success); width: fit-content; margin-top: 6px;"><code>models.model.root.Head</code></div>

	~~{{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.}}~~		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>HeadLayer</code> cube within the <code>Head</code> group), add more dots and names:

	~~For example, the following is equivalent to the~~ code ~~above for getting the~~ <code>~~Hat~~</~~code~~> ~~ModelPart.~~		<div style="padding: 4px 6px; border-radius: 6px; border: 3px solid var(--color-success); width: fit-content; margin-top: 6px;"><code>models.model.root.HeadLayer</code></div>

	<~~syntaxhighlight lang=~~"~~lua~~">		The second way to index is longer, and uses square brackets and quotes (<code>[""]</code>) to separate the names. '''This method is required if the name of a part contains characters that aren't letters, numbers, or underscores'''; this includes ''names with spaces'', like <code>Right Arm</code>.
	~~models~~.~~model.root.Head.HeadLayer~~
	</~~syntaxhighlight~~>

	~~However~~, ~~to access~~ the ~~cube named~~ <code>Cool Name</code>~~, you have to use the square~~ brackets~~. The two methods~~ can be mixed together:		When using brackets to index, place the name '''between the quotes''', and '''don't include a period before it''':
			* <div style="padding: 3px 4px; border-radius: 4px; border: 2px solid var(--color-success); width: fit-content; margin-top: 6px;"><code>models["model"]["root"]["Cool Name"]</code> ✓ Correct</div>
			* <div style="padding: 3px 4px; border-radius: 4px; border: 2px solid var(--color-success); width: fit-content; margin-top: 6px;"><code>models.model.root["Cool Name"]</code> ✓ Correct - both brackets and dots can be mixed together!</div>
			* <div style="padding: 3px 4px; border-radius: 4px; border: 2px solid var(--color-destructive); width: fit-content; margin-top: 6px;"><code>models.model.root.["Cool Name"]</code> ✗ Incorrect: '''don't put a dot <code>.</code> before the bracket <code>[</code>.'''</div>
			* <div style="padding: 3px 4px; border-radius: 4px; border: 2px solid var(--color-destructive); width: fit-content; margin-top: 6px;"><code>models.model.root[Cool Name]</code> ✗ Incorrect: '''name in brackets is missing a set of quotes'''</div>

	<~~syntaxhighlight lang~~="~~lua~~">		To return to using dots for indexing after using brackets, place the dot after the closing bracket:
	models.model.root["Cool ~~Name~~"]		* <div style="padding: 3px 4px; border-radius: 4px; border: 2px solid var(--color-success); width: fit-content; margin-top: 6px;"><code>models.model.root["Cool Group"].cube</code> ✓ Correct</div>
	</~~syntaxhighlight~~>		* <div style="padding: 3px 4px; border-radius: 4px; border: 2px solid var(--color-destructive); width: fit-content; margin-top: 6px;"><code>models.model.root["Cool Group"]cube</code> ✗ Incorrect: '''missing dot <code>.</code> after bracket'''<div>

	=== A note on model files in folders ===		=== A note on model files in folders ===

PenguinEncounter: don't show hatnote when tx'd

2025-01-25T06:45:10Z

don't show hatnote when tx'd

← Older revision		Revision as of 06:45, 25 January 2025
Line 1:		Line 1:
	{{Hatnote\|For technical documentation on ModelParts, see [[ModelPart]].}}		<noinclude>{{Hatnote\|For technical documentation on ModelParts, see [[ModelPart]].}}</noinclude>

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

PenguinEncounter: PenguinEncounter moved page User:PenguinEncounter/ModelPart Indexing to ModelPart Indexing: Publishing page

2025-01-25T06:42:42Z

PenguinEncounter moved page User:PenguinEncounter/ModelPart Indexing to ModelPart Indexing: Publishing page

← Older revision		Revision as of 06:42, 25 January 2025
(No difference)

PenguinEncounter: ready to go

2025-01-25T06:42:24Z

ready to go

← Older revision		Revision as of 06:42, 25 January 2025
Line 1:		Line 1:
	{{~~Notice/Warning~~\|~~content=This page is a draft~~, ~~and is not complete~~.}}		{{Hatnote\|For technical documentation on ModelParts, see [[ModelPart]].}}

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

PenguinEncounter: /* A note on model files in folders */ spell

2025-01-25T06:28:42Z

A note on model files in folders: spell

← Older revision		Revision as of 06:28, 25 January 2025
Line 54:		Line 54:

	{{Notice\|content=		{{Notice\|content=
	If you later want to use animations from a model, ~~folder~~ affect the indexing into the <code>animations</code> table too - but the system is a little different.		If you later want to use animations from a model, folders affect the indexing into the <code>animations</code> table too - but the system is a little different.

	Instead of indexing the folder and then the file, ''combine each folder name and the file name with a period <code>.</code> and index with the combined name'', even if the names of the folders and files contain special characters. For example, to get the animations from the <code>model 2.bbmodel</code> file in the <code>main models</code> folder:		Instead of indexing the folder and then the file, ''combine each folder name and the file name with a period <code>.</code> and index with the combined name'', even if the names of the folders and files contain special characters. For example, to get the animations from the <code>model 2.bbmodel</code> file in the <code>main models</code> folder:

PenguinEncounter: finish it (?)

2025-01-25T06:28:26Z

finish it (?)

← Older revision		Revision as of 06:28, 25 January 2025
Line 24:		Line 24:

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	models["model"]["Head"]		models["model"]["root"]["Head"]
	</syntaxhighlight>		</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:		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>HeadLayer</code> cube within the <code>Head</code> group), add more indexing:

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

Line 40:		Line 40:

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

			However, to access the cube named <code>Cool Name</code>, you have to use the square brackets. The two methods can be mixed together:

			<syntaxhighlight lang="lua">
			models.model.root["Cool Name"]
			</syntaxhighlight>

			=== A note on model files in folders ===

			If your Blockbench model file is within a folder in your avatar, the ''folder'' will become a part of the ModelPart tree. That means that if a model file named <code>player.bbmodel</code> is located in a folder named <code>models</code>, the model file has to be accessed with <code>models.models.player</code> (or <code>models["models"]["player"]</code>.)

			{{Notice\|content=
			If you later want to use animations from a model, folder affect the indexing into the <code>animations</code> table too - but the system is a little different.

			Instead of indexing the folder and then the file, ''combine each folder name and the file name with a period <code>.</code> and index with the combined name'', even if the names of the folders and files contain special characters. For example, to get the animations from the <code>model 2.bbmodel</code> file in the <code>main models</code> folder:

			{{tree\|icon=FSFolderClosed.png\|content=<code>main models</code>\|inner=
			{{tree\|icon=BBModel.png\|content=<code>model 2.bbmodel</code>}}
			}}

			<syntaxhighlight lang="lua">
			animations["main models.model 2"]
			</syntaxhighlight>
			}}

PenguinEncounter at 05:48, 25 January 2025

2025-01-25T05:48:59Z

← Older revision		Revision as of 05:48, 25 January 2025
Line 15:		Line 15:
	{{tree\|icon=BBCube.png\|content=RightArmLayer}}		{{tree\|icon=BBCube.png\|content=RightArmLayer}}
	}}		}}
	{{tree\|icon=BBCube.png\|content=~~Super Mega Awesome Thing~~}}		{{tree\|icon=BBCube.png\|content=Cool Name}}
	}}		}}
	}}		}}

PenguinEncounter: add diagram back

2025-01-25T05:48:32Z

add diagram back

← Older revision		Revision as of 05:48, 25 January 2025
Line 4:		Line 4:

	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.		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=Super Mega Awesome Thing}}
			}}
			}}

	To access a child part, ''index'' the parent part with the name of the child part.		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">		There are two ways to ''index'' something in Lua. The first way is by using brackets and quotes:

			<syntaxhighlight lang="lua">
	models["model"]["Head"]		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">		</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"]		models["model"]["Head"]["Hat"]
	</syntaxhighlight>The second way to index is shorter, and uses a <code>.</code> to separate the names.		</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.}}		{{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">
			For example, the following is equivalent to the code above for getting the <code>Hat</code> ModelPart.

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

PenguinEncounter: New tutorial that Jimmy hopefully thinks is better

2025-01-25T05:46:26Z

New tutorial that Jimmy hopefully thinks is better

New page

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

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>