Created a page for the Open World node. |
Updated this node page, just realized you can open worlds this way. |
||
| (One intermediate revision by the same user not shown) | |||
| Line 24: | Line 24: | ||
|}} | |}} | ||
The <code>Open World</code> node is used to open a world when called, given a valid | The <code>Open World</code> node is used to open a world when called, given a valid [[Type:Uri|Url]] and a set of optional parameters the user can give it to open a world in a certain way. You can chain this node with the [[ProtoFlux:Focus World|Focus World]] node by using this node's SessionURL connected to the focus world node. | ||
You can easily make a custom loading indicator using this node just by turning off the loading indicator and utilizing the OnOpenStart Async Continuation, however there is no way to make a custom loading bar to have an "accurate" percentage, thus is a tradeoff. | You can easily make a custom loading indicator using this node just by turning off the loading indicator and utilizing the OnOpenStart Async Continuation, however there is no way to make a custom loading bar to have an "accurate" percentage, thus is a tradeoff. | ||
| Line 42: | Line 42: | ||
=== WorldLink ([[Type:IWorldLink|IWorldLink]]) === | === WorldLink ([[Type:IWorldLink|IWorldLink]]) === | ||
The link to a world ( | The link to a world (using the [[Component:WorldLink|WorldLink]] component). This can be an alternative way of opening a world. | ||
=== Relation ([[Type:Relation|Relation]]) === | === Relation ([[Type:Relation|Relation]]) === | ||
Latest revision as of 00:52, 12 September 2024
The Open World node is used to open a world when called, given a valid Url and a set of optional parameters the user can give it to open a world in a certain way. You can chain this node with the Focus World node by using this node's SessionURL connected to the focus world node.
You can easily make a custom loading indicator using this node just by turning off the loading indicator and utilizing the OnOpenStart Async Continuation, however there is no way to make a custom loading bar to have an "accurate" percentage, thus is a tradeoff.
This node is also useful when making Exit Strategies, as you can set it up to where if the world is valid to open and using the AutoFocus option, you can jump to the new focused world, and have the node continue from here to play a particle effect, a sound, and much more. Combining it further with the focus world node to close the old world is also an option.
Inputs
* (AsyncCall)
Calls from an impulse to open a world with a given URL.
URL (Uri)
The World URL needed to open a world.
WorldLink (IWorldLink)
The link to a world (using the WorldLink component). This can be an alternative way of opening a world.
Relation (Relation)
The relation to a world (Not necessary for opening a world).
GetExisting (bool)
Should this try to get an already opened world first.
LoadingIndicator (bool)
Should this show a loading indicator to the user that is opening the world.
AutoFocus (bool)
Should this automatically focus the user to the opened world as soon as it opens.
MakePrivate (bool)
Should this make the opening world private when opening it.
Outputs
OnOpenStart (AsyncCall)
Fires when the world has started to open.
OnOpenDone (AsyncCall)
Fires when the world has finished opening.
OnWorldReady (Continuation)
Fires when the world has finished opening and is ready to hold users.
OnOpenFail (Continuation)
Fires when the world could not be opened or the world URL is not valid.
SessionID (String)
The session ID for the opened world and user connection to it.
SessionURL (Uri)
The world URL for the opened session.