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. When attached to a slot it allows that slot to be set as a user's custom world loading progress indicator from their inventory. When used it will appear in-place of the default Resonite world loading progress indicator.

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. Some components stop their functionality when this field is disabled, but some don't.
Progress	SyncRef<IField<float>>	Float field where 0.0 - 1.0 progress will be written.
WorldName	SyncRef<IField<string>>	String field where the loading world's name will be written.
Stage	SyncRef<IField<ProgressStage>>	SyncRef ProgressStage Field (To-Do: Need info on ProgressStage fields and what provides them.)
PhaseName	SyncRef<IField<string>>	String field where the current loading phase name will be written.
SubPhaseName	SyncRef<IField<string>>	String field where the current loading sub-phase name will be written.
HasCompleted	SyncRef<IField<bool>>	Boolean field that will be set to true on loading completion.
HasFailed	SyncRef<IField<bool>>	Boolean field that will be set to true on loading failure.
CompletionMessage	SyncRef<IField<string>>	String field where message indicating completion will be written.
FailureReason	SyncRef<IField<string>>	String field where message indicating reason for loading failure will be written.
LoadingAssets	SyncRef<IField<bool>>	Boolean field that is set true while loading assets.
LoadedAssets	SyncRef<IField<int>>	Integer field counting loaded assets.
TotalAssets	SyncRef<IField<int>>	Integer field counting total assets to be loaded.
LoadedTextures2D	SyncRef<IField<int>>	Integer field counting loaded ITexture2D assets.
TotalTextures2D	SyncRef<IField<int>>	Integer field counting total ITexture2D assets to be loaded.
LoadedTextures3D	SyncRef<IField<int>>	Integer field counting loaded ITexture3D assets.
TotalTextures3D	SyncRef<IField<int>>	Integer field counting total ITexture3D assets to be loaded.
LoadedCubemaps	SyncRef<IField<int>>	Integer field counting loaded Cubemap assets.
TotalCubemaps	SyncRef<IField<int>>	Integer field counting total Cubemap assets to be loaded.
LoadedVideos	SyncRef<IField<int>>	Integer field counting loaded Video assets.
TotalVideos	SyncRef<IField<int>>	Integer field counting total Video assets to be loaded.
LoadedMeshes	SyncRef<IField<int>>	Integer field counting loaded Mesh assets.
TotalMeshes	SyncRef<IField<int>>	Integer field counting total Mesh assets to be loaded.
LoadedAudioClips	SyncRef<IField<int>>	Integer field counting loaded Audio assets.
TotalAudioClips	SyncRef<IField<int>>	Integer field counting total Audio assets to be loaded.
LoadedShaders	SyncRef<IField<int>>	Integer field counting loaded Shader assets.
TotalShaders	SyncRef<IField<int>>	Integer field counting total Shader assets to be loaded.
LoadedFonts	SyncRef<IField<int>>	Integer field counting loaded Font assets.
TotalFonts	SyncRef<IField<int>>	Integer field counting total Font assets to be loaded.
BytesDownloaded	SyncRef<IField<long>>	Long field counting total bytes downloaded so far.
TotalBytes	SyncRef<IField<long>>	Long field count of total bytes expected to be downloaded.
BytesPerSecond	SyncRef<IField<long>>	Long field indicating current Bytes-per-Second download rate.
ProgressBar	SyncRef<ProgressBarInterface>	Reference to a ProgressBarInterface component.

Related Components

• ProgressBarInterface is used for progress indicators on asset importing.