Scripting API
Scripting API
ScenePace
Enum in Abyss.Core, from Abyss.Core.
How a scene comes in once all of it is built, and how it goes when it is unloaded: in one frame, or over several.
public enum ScenePaceRemarks
Showing a scene moves each of its entities once, as switching each on would: about a tenth of a microsecond each, measured — a millisecond for ten thousand, eleven for a hundred thousand, on a fast machine. Hiding one as its unload starts costs a little less. All at once is right for most scenes; one big enough to be felt in the frame it appears or goes in can come and go over several instead.
Values
| Name | Value | Description |
|---|---|---|
AtOnce | 0 | In one frame. Loaded, nothing of it is seen before and all of it after; unloaded, all of it is hidden at once, and then despawned a slice at a time. |
Gradual | 1 | Over several frames, a few entities a piece, as many as the loader's budget allows a frame: for a scene big enough that all at once would be felt, behind a loading screen or out of view. Loaded, it comes in in the order the file has it, never a child before its parent, and is loading until all of it is shown. Unloaded, nothing of it is hidden first: it is despawned from the end, everything under an entity before it, and what is not despawned yet is still seen, by systems and the renderer, until it is. A game that wants it out of sight at once can set Visibility to Hidden on its entities with no parent, which what is under them inherits, and let it go gradually behind that. |
