ModelPart - Revision history

PenguinEncounter: /* Accessing ModelParts */ transclude for now, until faq updated

2025-01-25T06:44:35Z

Accessing ModelParts: transclude for now, until faq updated

← Older revision		Revision as of 06:44, 25 January 2025
Line 4:		Line 4:

	== Accessing ModelParts ==		== Accessing ModelParts ==
	{{~~Hatnote~~\|~~See [[~~ModelPart Indexing~~]].~~}}		{{tx\|:ModelPart Indexing}}

	== ParentTypes ==		== ParentTypes ==

PenguinEncounter: /* Accessing ModelParts */

2025-01-25T06:43:12Z

Accessing ModelParts

@@ Line 4: / Line 4: @@
 == Accessing ModelParts ==
-<code>models</code> is the global that acts as the Root of your avatar and is where all ModelParts are stored, either as a child of <code>models</code>, a child of a child, or further down the tree.
+{{Hatnote|See [[ModelPart Indexing]].}}
 == ParentTypes ==

KitCat962: syntax spacing

2024-12-14T03:52:06Z

syntax spacing

← Older revision		Revision as of 03:52, 14 December 2024
Line 17:		Line 17:
	This logic is the same for every single ModelPart. If you want to access a child, index the parent with the child's name.		This logic is the same for every single ModelPart. If you want to access a child, index the parent with the child's name.

	{{note\|<code>models</code> itself is a ModelPart. This allows you to apply transformations to the entire model, using e.g. <code>models:setScale(0.5)</code>.\|tag=Trivia\|color=#A155DA}}Take below for example:{{tree\|icon=BBModel.png\|content=<code>model.bbmodel</code>\|inner=		{{note\|<code>models</code> itself is a ModelPart. This allows you to apply transformations to the entire model, using e.g. <code>models:setScale(0.5)</code>.\|tag=Trivia\|color=#A155DA}}

			Take below for example:
			{{tree\|icon=BBModel.png\|content=<code>model.bbmodel</code>\|inner=
	{{tree\|icon=BBGroup.png\|content=root\|inner=		{{tree\|icon=BBGroup.png\|content=root\|inner=
	{{tree\|icon=BBGroup.png\|content=Head\|inner=		{{tree\|icon=BBGroup.png\|content=Head\|inner=

KitCat962: Grammer

2024-12-14T03:49:54Z

Grammer

← Older revision		Revision as of 03:49, 14 December 2024
Line 17:		Line 17:
	This logic is the same for every single ModelPart. If you want to access a child, index the parent with the child's name.		This logic is the same for every single ModelPart. If you want to access a child, index the parent with the child's name.

	{{note\|<code>models</code> itself is a ModelPart. This allows you to apply transformations to the entire model, using e.g. <code>models:setScale(0.5)</code>.\|tag=Trivia\|color=#A155DA}}		{{note\|<code>models</code> itself is a ModelPart. This allows you to apply transformations to the entire model, using e.g. <code>models:setScale(0.5)</code>.\|tag=Trivia\|color=#A155DA}}Take below for example:{{tree\|icon=BBModel.png\|content=<code>model.bbmodel</code>\|inner=

	{{tree\|icon=BBModel.png\|content=<code>model.bbmodel</code>\|inner=
	{{tree\|icon=BBGroup.png\|content=root\|inner=		{{tree\|icon=BBGroup.png\|content=root\|inner=
	{{tree\|icon=BBGroup.png\|content=Head\|inner=		{{tree\|icon=BBGroup.png\|content=Head\|inner=
Line 33:		Line 31:
	}}		}}

	The ~~below example accesses~~ the {{Emoji\|BBCube.png}} RightArm cube:		The way to access the {{Emoji\|BBCube.png}} RightArm cube would be the following:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local head = models["model"]["root"]["RightArm"]["RightArm"]		local head = models["model"]["root"]["RightArm"]["RightArm"]

PenguinEncounter: /* Accessing ModelParts */ okay here's the diagram

2024-12-14T03:42:06Z

Accessing ModelParts: okay here's the diagram

← Older revision		Revision as of 03:42, 14 December 2024
Line 19:		Line 19:
	{{note\|<code>models</code> itself is a ModelPart. This allows you to apply transformations to the entire model, using e.g. <code>models:setScale(0.5)</code>.\|tag=Trivia\|color=#A155DA}}		{{note\|<code>models</code> itself is a ModelPart. This allows you to apply transformations to the entire model, using e.g. <code>models:setScale(0.5)</code>.\|tag=Trivia\|color=#A155DA}}

	The below example accesses the ~~Head Group from the [[WikiExampleAvatar]]~~		{{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}}
			}}
			}}

			The below example accesses the {{Emoji\|BBCube.png}} RightArm cube:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local head = models["model"]["root"]["~~Head~~"]		local head = models["model"]["root"]["RightArm"]["RightArm"]
	</syntaxhighlight>		</syntaxhighlight>
	If the above seems tedious, Lua provides a shorthand way of indexing with strings. It only works when the string contains no spaces or special characters.		If the above seems tedious, Lua provides a shorthand way of indexing with strings. It only works when the string contains no spaces or special characters.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local head = models.model.root.~~Head~~		local head = models.model.root.RightArm.RightArm

	-- Below is invalid, as the name contains spaces		-- Below is invalid, as the name contains spaces
	local superMegaAwsomeThing = models.model.root.Super Mega ~~Awsome~~ Thing		local superMegaAwsomeThing = models.model.root.Super Mega Awesome Thing

	-- Super Mega Awsome Thing would need to be indexed with the normal method		-- Super Mega Awsome Thing would need to be indexed with the normal method
	local superMegaAwsomeThing = models.model.root["Super Mega ~~Awsome~~ Thing"]		local superMegaAwsomeThing = models.model.root["Super Mega Awesome Thing"]
	</syntaxhighlight>		</syntaxhighlight>

PenguinEncounter: /* ModelPart Methods */ Capitalization

2024-09-28T21:17:07Z

ModelPart Methods: Capitalization

← Older revision		Revision as of 21:17, 28 September 2024
Line 86:		Line 86:
	head:setParentType("None")		head:setParentType("None")
	</syntaxhighlight>		</syntaxhighlight>
	== ModelPart ~~Methods~~ ==		== ModelPart methods ==

	=== ModelPart ~~Properties~~ ===		=== ModelPart properties ===
	Read-only properties of a ModelPart		Read-only properties of a ModelPart

Line 121:		Line 121:
	</syntaxhighlight>		</syntaxhighlight>

	=== Editing ModelPart ~~Hierarchy~~ ===		=== Editing ModelPart hierarchy ===
	Methods relating to getting other ModelParts and manipulating the ModelPart tree		Methods relating to getting other ModelParts and manipulating the ModelPart tree

Line 699:		Line 699:
	</syntaxhighlight>		</syntaxhighlight>

	=== Visual ~~Manipulation~~ ===		=== Visual manipulation ===
	Methods relating to modifying how a ModelPart looks		Methods relating to modifying how a ModelPart looks

Line 990:		Line 990:
	todo: put all rendertask functions in here		todo: put all rendertask functions in here

	=== Render ~~Methods~~ ===		=== Render methods ===
	todo: Put partToWorldMatrix, preRender, midRender, and PostRender in here		todo: Put partToWorldMatrix, preRender, midRender, and PostRender in here

	=== Animation ~~Methods~~ ===		=== Animation methods ===
	todo: put getAnimPos/Rot/Scale and overrideVanillaPos/Rot/Scale in here		todo: put getAnimPos/Rot/Scale and overrideVanillaPos/Rot/Scale in here

	== Navigation ==		== Navigation ==
	{{Navbox documentation}}		{{Navbox documentation}}

Joeyy: added navbox

2024-09-28T20:38:31Z

added navbox

← Older revision		Revision as of 20:38, 28 September 2024
Line 995:		Line 995:
	=== Animation Methods ===		=== Animation Methods ===
	todo: put getAnimPos/Rot/Scale and overrideVanillaPos/Rot/Scale in here		todo: put getAnimPos/Rot/Scale and overrideVanillaPos/Rot/Scale in here

			== Navigation ==
			{{Navbox documentation}}

KitCat962: /* ParentTypes via BlockBench */ link to hud specifications/tutorial page

2024-09-28T20:16:06Z

ParentTypes via BlockBench: link to hud specifications/tutorial page

← Older revision		Revision as of 20:16, 28 September 2024
Line 63:		Line 63:
	Do note that some English words naturally start with a ParentType which can cause unintended behavior!		Do note that some English words naturally start with a ParentType which can cause unintended behavior!

	For example, the word "Guitar". Seems innocent, right? Well, "Guitar" starts with "Gui", and "Gui" is an alias for the ParentType <code>Hud</code>, a ParentType that binds the ModelPart to the Heads Up Display where the hotbar and inventory reside. This causes the ModelPart to not be visible, as <code>Hud</code> parts have special rules. Be careful!		For example, the word "Guitar". Seems innocent, right? Well, "Guitar" starts with "Gui", and "Gui" is an alias for the ParentType <code>Hud</code>, a ParentType that binds the ModelPart to the Heads Up Display where the hotbar and inventory reside. This causes the ModelPart to not be visible, as [[ParentType/Hud\|<code>Hud</code> parts have special rules]]. Be careful!

	<pre>Note: ParentTypes are sometimes called Keywords by legacy Figura users</pre>		<pre>Note: ParentTypes are sometimes called Keywords by legacy Figura users</pre>

Joeyy: /* ModelPart Methods */ add hr

2024-09-28T19:48:56Z

ModelPart Methods: add hr

Show changes

KitCat962: /* Visual Manipulation */ regex fail lmao

2024-09-28T16:18:43Z

Visual Manipulation: regex fail lmao

← Older revision		Revision as of 16:18, 28 September 2024
Line 676:		Line 676:
	todo: put anything related to renderType, textures, and other visual modifications in here		todo: put anything related to renderType, textures, and other visual modifications in here

	==== ~~ModelPart:~~setVisible ====		==== setVisible ====
	Sets if this ModelPart is visible or not. Children of this ModelPart will also be invisible while this part is invisible.		Sets if this ModelPart is visible or not. Children of this ModelPart will also be invisible while this part is invisible.

Line 693:		Line 693:
	</syntaxhighlight>		</syntaxhighlight>

	==== ~~ModelPart:~~getVisible ====		==== getVisible ====
	Recursively goes up the ModelPart tree until it finds a ModelPart that is invisible, or the ModelPart is <code>models</code>		Recursively goes up the ModelPart tree until it finds a ModelPart that is invisible, or the ModelPart is <code>models</code>

Line 717:		Line 717:
	</syntaxhighlight>		</syntaxhighlight>

	==== ~~ModelPart:~~setColor ====		==== setColor ====
	Sets a value to multiply with all pixels on the ModelPart's texture. Children of this ModelPart inherit the color, multiplied with their own.		Sets a value to multiply with all pixels on the ModelPart's texture. Children of this ModelPart inherit the color, multiplied with their own.

Line 758:		Line 758:
	</syntaxhighlight>		</syntaxhighlight>

	==== ~~ModelPart:~~getColor ====		==== getColor ====
	Gets the value set by <code>setColor</code>. Returns 1,1,1 when script begins.		Gets the value set by <code>setColor</code>. Returns 1,1,1 when script begins.

Line 778:		Line 778:
	'''@see''' [[#setColor\|setColor]],		'''@see''' [[#setColor\|setColor]],

	==== ~~ModelPart:~~setOpacity ====		==== setOpacity ====
	Sets the opacity of the ModelPart. Children of this ModelPart inherit the opacity, multiplied with their own.		Sets the opacity of the ModelPart. Children of this ModelPart inherit the opacity, multiplied with their own.

Line 802:		Line 802:
	</syntaxhighlight>		</syntaxhighlight>

	==== ~~ModelPart:~~getOpacity ====		==== getOpacity ====
	Gets the value set by <code>setOpacity</code>. Returns 1 when script begins.		Gets the value set by <code>setOpacity</code>. Returns 1 when script begins.

Line 822:		Line 822:
	'''@see''' [[#setOpacity\|setOpacity]],		'''@see''' [[#setOpacity\|setOpacity]],

	==== ~~ModelPart:~~setLight ====		==== setLight ====
	Overrides the lightlevels used to render the ModelPart. Children of this ModelPart inherit the lightlevel.		Overrides the lightlevels used to render the ModelPart. Children of this ModelPart inherit the lightlevel.

Line 855:		Line 855:
	'''@see''' [[PlayerAPI#PlayerAPI:getPos\|player:getPos]] [[WorldAPI#WorldAPI.getBlockLightLevel\|world.getBlockLightLevel]] [[WorldAPI#WorldAPI.getSkyLightLevel\|world.getSkyLightLevel]]		'''@see''' [[PlayerAPI#PlayerAPI:getPos\|player:getPos]] [[WorldAPI#WorldAPI.getBlockLightLevel\|world.getBlockLightLevel]] [[WorldAPI#WorldAPI.getSkyLightLevel\|world.getSkyLightLevel]]

	==== ~~ModelPart:~~getLight ====		==== getLight ====
	Gets the value set by <code>setLight</code>. Returns <code>nil</code> when script begins.		Gets the value set by <code>setLight</code>. Returns <code>nil</code> when script begins.

Line 879:		Line 879:
	'''@see''' [[#setLight\|setLight]],		'''@see''' [[#setLight\|setLight]],

	==== ~~ModelPart:~~setOverlay ====		==== setOverlay ====
	Overrides the values used for rendering the red damage tint and the white creeper fuse effect. Really only useful for preventing the damage overlay from rendering on stuff like armor.		Overrides the values used for rendering the red damage tint and the white creeper fuse effect. Really only useful for preventing the damage overlay from rendering on stuff like armor.

Line 925:		Line 925:
	</syntaxhighlight>		</syntaxhighlight>

	==== ~~ModelPart:~~getOverlay ====		==== getOverlay ====
	Gets the value set by <code>setOverlay</code>. Returns <code>nil</code> when script begins.		Gets the value set by <code>setOverlay</code>. Returns <code>nil</code> when script begins.