PlayManager
Link to playmanager
This class was added by a mod with mod-id cinematic_transitions. So you need to have this mod installed if you want to use this feature.
Importing the class
Link to importing-the-class
It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.
ZenScript Copyimport mods.cinematic_transitions.PlayManager;
Static Methods
Link to static-methods
Name: playPopUp
Return Type: void
ZenScript CopyPlayManager.playPopUp(registryName as string) as void
| Parameter | Type | Description |
|---|---|---|
Parameter registryName | Type string | Description take the registry name of a PopUp registered using Json, plays the popup provided. |
Name: playTransition
Plays transition (black bars on the top and bottom of screen) with no children (popups)
Return Type: void
ZenScript Copy// PlayManager.playTransition() as void
PlayManager.playTransition();
Name: playTransition
Return Type: void
ZenScript CopyPlayManager.playTransition(childName as string) as void
| Parameter | Type | Description |
|---|---|---|
Parameter childName | Type string | Description Plays transition with child. Syncs up the child wait duration and transition length to parent's |
Name: registerBiomePopUpListener
Registers a listener that triggers given popup when player enters given biome
Return Type: void
ZenScript CopyPlayManager.registerBiomePopUpListener(biomeName as string, popUp as string, hasTransition as boolean) as void
| Parameter | Type | Description |
|---|---|---|
Parameter biomeName | Type string | Description registry name of biome |
Parameter popUp | Type string | Description registry name of popup |
Parameter hasTransition | Type boolean | Description whether if transition should be played |
Name: registerDimensionPopUpListener
Registers a listener that triggers given popup when player enters given dimension
Return Type: void
ZenScript CopyPlayManager.registerDimensionPopUpListener(dimensionName as string, popUp as string, hasTransition as boolean) as void
| Parameter | Type | Description |
|---|---|---|
Parameter dimensionName | Type string | Description registry name of dimension |
Parameter popUp | Type string | Description registry name of popup |
Parameter hasTransition | Type boolean | Description whether if transition should be played |
Name: registerEntityPopUpListener
Registers a listener that triggers given popup when given entity spawns
Return Type: void
ZenScript CopyPlayManager.registerEntityPopUpListener(entityName as string, popUp as string, hasTransition as boolean) as void
| Parameter | Type | Description |
|---|---|---|
Parameter entityName | Type string | Description entity type |
Parameter popUp | Type string | Description registry name of popup |
Parameter hasTransition | Type boolean | Description whether if transition should be played |
Name: registerStructurePopUpListener
Registers a listener that triggers given popup when player enters given structure
Return Type: void
ZenScript CopyPlayManager.registerStructurePopUpListener(structureName as string, popUp as string, hasTransition as boolean) as void
| Parameter | Type | Description |
|---|---|---|
Parameter structureName | Type string | Description registry name of structure |
Parameter popUp | Type string | Description registry name of popup |
Parameter hasTransition | Type boolean | Description whether if transition should be played |
Name: setHideInventory
Return Type: void
ZenScript CopyPlayManager.setHideInventory(hideInventory as boolean) as void
| Parameter | Type | Description |
|---|---|---|
Parameter hideInventory | Type boolean | Description whether if the hotbar, health, etc should be hidden during popup/transition |