Component:WorldLoadingProgressInterface

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Component image 

World Loading Progress Interface component as seen in the Scene Inspector

WorldLoadingProgressInterface is the key component in the creation of a user-definable world loading progress bar. See Favorites for favoritable items like this one.

Fields

Fields

Name	Type	Description
persistent	Bool	Determines whether or not this item will be saved to the server.
UpdateOrder	Int	Controls the order in which this component is updated.
Enabled	Bool	Controls whether or not this component is enabled.
ItemName	IField`1<String>
SpawningUser	UserRef
SpawningUserID	IField`1<String>
IsInstance	Bool
Progress	IField`1<Float>	Float field where 0.0 - 1.0 progress will be written.
WorldName	IField`1<String>	String field where the loading world's name will be written.
Stage	IField`1<ProgressStage>	SyncRef ProgressStage Field (To-Do: Need info on ProgressStage fields and what provides them.)
PhaseName	IField`1<String>	String field where the current loading phase name will be written.
SubPhaseName	IField`1<String>	String field where the current loading sub-phase name will be written.
HasCompleted	IField`1<Bool>	Boolean field that will be set to true on loading completion.
HasFailed	IField`1<Bool>	Boolean field that will be set to true on loading failure.
CompletionMessage	IField`1<String>	String field where message indicating completion will be written.
FailureReason	IField`1<String>	String field where message indicating reason for loading failure will be written.
LoadingAssets	IField`1<Bool>	Boolean field that is set true while loading assets.
LoadedAssets	IField`1<Int>	Integer field counting loaded assets.
TotalAssets	IField`1<Int>	Integer field counting total assets to be loaded.
LoadedTextures2D	IField`1<Int>	Integer field counting loaded ITexture2D assets.
TotalTextures2D	IField`1<Int>	Integer field counting total ITexture2D assets to be loaded.
LoadedTextures3D	IField`1<Int>	Integer field counting loaded ITexture3D assets.
TotalTextures3D	IField`1<Int>	Integer field counting total ITexture3D assets to be loaded.
LoadedCubemaps	IField`1<Int>	Integer field counting loaded Cubemap assets.
TotalCubemaps	IField`1<Int>	Integer field counting total Cubemap assets to be loaded.
LoadedVideos	IField`1<Int>	Integer field counting loaded Video assets.
TotalVideos	IField`1<Int>	Integer field counting total Video assets to be loaded.
LoadedMeshes	IField`1<Int>	Integer field counting loaded Mesh assets.
TotalMeshes	IField`1<Int>	Integer field counting total Mesh assets to be loaded.
LoadedAudioClips	IField`1<Int>	Integer field counting loaded Audio assets.
TotalAudioClips	IField`1<Int>	Integer field counting total Audio assets to be loaded.
LoadedShaders	IField`1<Int>	Integer field counting loaded Shader assets.
TotalShaders	IField`1<Int>	Integer field counting total Shader assets to be loaded.
LoadedFonts	IField`1<Int>	Integer field counting loaded Font assets.
TotalFonts	IField`1<Int>	Integer field counting total Font assets to be loaded.
BytesDownloaded	IField`1<Long>	Long field counting total bytes downloaded so far.
TotalBytes	IField`1<Long>	Long field count of total bytes expected to be downloaded.
BytesPerSecond	IField`1<Long>	Long field indicating current Bytes-per-Second download rate.
ProgressBar	ProgressBarInterface	Reference to a ProgressBarInterface component.

See Also

• Favorites
• Component:WorldLoadingProgressInterface
• Component:AudioPlayerInterface
• Component:AudioStreamInterface
• Component:VideoPlayerInterface
• Component:ProgressBarInterface
• Component:NamePlateInterface
• Component:ColorDialogInterface
• Component:NoticeDisplayInterface
• Component:TextDisplayInterface
• Component:HyperlinkDisplayInterface
• Component:DocumentInterface