Moduprint/API/Methods: Difference between revisions

Revision as of 16:25, 4 August 2025

All methods listed here are accessible through slot Dynamic Reference Variables named Manager/Method.name.

HideTabContent

Hides the tab's content. To set a tab active, use SetTabActive instead. This method is only useful for unpacking flux into multiple tabs.

Context
Name	Type		Purpose
`Tab`	`Slot`	Required	Tab whose content should be hidden.

NewPrint

Creates a new print under the local user's space. Use NewPrintTab if you need the print to be created at a specific location.

Result
Name	Type	Purpose
`Manager/Local.Result`	`Slot`	The created print.

NewPrintAt

Creates a new print.

Context
Name	Type		Purpose
`Parent`	`Slot`	Optional	The parent of the print, defaults to local user space.
`Position`	`float3`	Optional	Global Position.
`Rotation`	`floatQ`	Optional	Global Rotation.
`Scale`	`float3`	Optional	Global Scale, defaults to `1`.

Result
Name	Type	Purpose
`Manager/Local.Result`	`Slot`	The created print.

NewTab, NewActiveTab

Context
Name	Type		Purpose
`Print`	`Slot`	Required	The print to create a new tab on.

Result
Name	Type	Purpose
`Manager/Local.Result`	`Slot`	The created tab.

NewTabWithContent

The tab content holder is created directly under the provided pack target slot.

Context
Name	Type		Purpose
`Print`	`Slot`	Required	The print to create a new tab on.
`Content`	`Slot`	Required	The content slot of the tab.
`PackTarget`	`Slot`	Optional	Where the tab is parented to.

Result
Name	Type	Purpose
`Manager/Local.Result`	`Slot`	The created tab.

Register

Adds an entry to a registry. Prefer using Module/Lifecycle.Register for adding entries to a registry. This is only useful if you need to register something after the module was already installed. See Moduprint/API#Registries for more information.

Context
Name	Type		Purpose
`Entry`	`Slot`	Required	Slot that should be registered.
`Registry`	`String`	Required	Name of the registry this entry belongs to.
`Priority`	`String`	Optional	Entry priority in the registry, see below.

SetTabActive

Context
Name	Type		Purpose
`Tab`/`Print`	`Slot`	Required	The tab to set active or the print itself to set no tab active.

ShowTabContent

Shows the tab's content. To set a tab active, use SetTabActive instead. This method is only useful for unpacking flux into multiple tabs.

Context
Name	Type		Purpose
`Tab`	`Slot`	Required	Tab whose content should be shown.

Snap

Context
Name	Type		Purpose
`Print`	`Slot`	Required	The print to snap to.
`Target`	`Slot`	Required	Object to snap to the print.

Result
Name	Type	Purpose
`Manager/Local.Result`	`String`	`Default`, `Drop`, `Handled`.

UnregisterAllByModule

Removes all entries from all registries that were created by a module. Prefer using Module/Lifecycle.Register for adding entries to a registry. This is automatically called when a module is uninstalled. You should not need to call this manually.

Context
Name	Type		Purpose
`ID`	`String`	Required	Module ID.

@@ Line 91: / Line 91: @@
 |-
 | <code>Manager/Local.Result</code> || {{Template:TypeColorCard|Slot}} || The created tab.
+|}
+=== Register ===
+Adds an entry to a registry. Prefer using <code>Module/Lifecycle.Register</code> for adding entries to a registry. This is only useful if you need to register something after the module was already installed. See [[Moduprint/API#Registries]] for more information.
+{| class="wikitable"
+|+Context
+|-
+! Name !! Type !! !! Purpose
+|-
+| <code>Entry</code>      || {{Template:TypeColorCard|Slot}} || Required || Slot that should be registered.
+|-
+| <code>Registry</code> || {{Template:TypeColorCard|String}}  || Required || Name of the registry this entry belongs to.
+|-
+| <code>Priority</code>    || {{Template:TypeColorCard|String}} || Optional || Entry priority in the registry, see below.
 |}
@@ Line 133: / Line 149: @@
 |-
 | <code>Manager/Local.Result</code> || {{Template:TypeColorCard|String}} || <code>Default</code>, <code>Drop</code>, <code>Handled</code>.
+|}
+=== UnregisterAllByModule ===
+Removes all entries from all registries that were created by a module. Prefer using <code>Module/Lifecycle.Register</code> for adding entries to a registry. This is automatically called when a module is uninstalled. You should not need to call this manually.
+{| class="wikitable"
+|+Context
+|-
+! Name !! Type !! !! Purpose
+|-
+| <code>ID</code> || {{Template:TypeColorCard|String}} || Required || Module ID.
 |}