Enfusion Script API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
WorldSaveItem Interface Reference
Inheritance diagram for WorldSaveItem:
[legend]

Public Member Functions

proto native void DeleteOnline (BackendCallback callback)
 Request delete of this item from the backend storage.
 
proto native void FillManifest (out notnull WorldSaveManifest manifest)
 
proto native int CreatedAt ()
 
proto native void DeleteOffline ()
 
proto native void Save (notnull WorldSaveManifest manifest)
 
proto native WorldSaveItem UploadWorldSave (notnull WorldSaveManifest manifest, BackendCallback callback)
 
- Public Member Functions inherited from WorkshopItem
void ~WorkshopItem ()
 
proto native WorkshopAuthor Author ()
 Get name of the author.
 
proto native int Contributors (out notnull array< WorkshopAuthor > contributors)
 Get contributors of this Item.
 
proto native void Subscribe (BackendCallback callback)
 Subscribe this Item.
 
proto native void Unsubscribe (BackendCallback callback)
 Unsubscribe this Item.
 
proto native bool IsSubscribed ()
 Is this item subscribed?
 
proto native void LoadScenarios (BackendCallback callback, notnull Revision revision)
 Load revision's scenarios.
 
proto native void LoadChangelog (BackendCallback callback, notnull Revision revision)
 Load revision's changelog.
 
proto native void Report (EWorkshopReportType eReport, string sMessage, BackendCallback callback)
 Call report (feedback) upon specific item.
 
proto native void CancelReport (BackendCallback callback)
 Deletes an existing report from backend.
 
proto native void LoadReport (BackendCallback callback)
 Loads existing report from backend.
 
proto native string GetReportDescription ()
 Returns description of report.
 
proto native int GetReportType ()
 Returns type of report.
 
proto native int GetStateFlags ()
 Get current state flags (EWorkshopItemState)
 
proto native float GetSizeBytes ()
 Get size of the package in bytes.
 
proto native float AverageRating ()
 Get average rating - number in <0,5>
 
proto native void ResetRating (BackendCallback callback)
 Reset my rating.
 
proto native void Rate (bool upvote, BackendCallback callback)
 Set rating.
 
proto native bool IsRatingSet ()
 Is my rating set.
 
proto native bool MyRating ()
 Get rating value - true upvote, false downvote.
 
proto native int RatingCount ()
 Get rating count.
 
proto native int GetTags (out notnull array< WorkshopTag > items)
 Copy all tags to given Array.
 
proto native bool IsProcessed ()
 Returns true if process pending ATM (download, upload, delete)
 
proto native void Enable (bool enable)
 Activate addon.
 
proto native bool IsEnabled ()
 Returns True if addon is currently activated.
 
proto native string License ()
 Read Licence type.
 
proto native string LicenseText ()
 Read Licence text.
 
proto native int Gallery (out notnull array< BackendImage > gallery)
 Get image gallery.
 
proto native void SetFavorite (BackendCallback callback, bool isFavorite)
 Add to favourites.
 
proto native bool IsFavorite ()
 Returns True - when item when item is Favourite.
 
proto native void PauseDownload (BackendCallback callback)
 Pause download.
 
proto native void ResumeDownload (BackendCallback callback)
 Resume download.
 
proto native bool EnoughLocalSpace ()
 Is there enough space on the local storage.
 
proto native bool IsLoaded ()
 True if not only enabled, but actually loaded.
 
proto native bool HasAnyTag (notnull array< WorkshopTag > tags)
 Results True if any of tags passed via.
 
proto native int GetAccessState ()
 Returns access state flag -> EWorkshopItemAccessState.
 
proto native int GetTimeSinceFirstDownload ()
 Time in seconds since we downloaded this addon first time.
 
proto native int GetTimeSinceLastPlay ()
 Time since last time we played with this addon.
 
proto native void NotifyPlay ()
 Resets TimeSinceLastPlay value.
 
proto native owned string GetBackendEnv ()
 Read actual environment as string (can be validated against addon to confirm source and current environment are same)
 
proto native bool IsReadyToRun ()
 Returns True - when item or dependencies are not Offline and Revision is equal to selected.
 
proto native bool IsUnlisted ()
 True when mod have been Unlisted (regular maintenance when major update is released)
 
proto native bool IsAuthor ()
 Is the current user author of this asset.
 
proto native bool IsContributor ()
 Is the current user contributor of this asset.
 
- Public Member Functions inherited from DownloadableItem
proto native string Id ()
 
proto native void Download (BackendCallback callback, Revision revision)
 Request download of this item.
 
proto native void AskDetail (BackendCallback callback)
 Request detail info.
 
proto native float GetProgress ()
 Get Download/ Upload progress in range <0.0.
 
proto native float GetProcessingProgress ()
 Get download/update progress based on file operations in range <0.0.
 
proto native bool IsProcessing ()
 True if download is waiting for file processing.
 
proto native BackendImage Thumbnail ()
 Get thumbnail image.
 
proto native bool HasLatestVersion ()
 Is the local version the latest one?
 
proto native int GetRevisions (out notnull array< Revision > revisions)
 
proto native Revision GetActiveRevision ()
 Returns currently used revision or null if no revision is downloaded.
 
proto native Revision GetDownloadingRevision ()
 Returns currently downloading revision.
 
proto native void Cancel (BackendCallback callback)
 Cancel upload or download.
 
proto native void DeleteLocally ()
 Delete local copy of an asset.
 
proto native void DeleteDownloadProgress ()
 
proto native Revision GetPendingDownload ()
 
proto native void SetScriptFlag (int iFlag)
 Set script-defined persistent flags.
 
proto native void ClearScriptFlag (int iFlag)
 Clear script-defined persistent flags.
 
proto native int GetScriptFlag ()
 Get script-defined persistent flags.
 
proto native Revision GetLatestRevision ()
 
proto native void LoadDependencies (BackendCallback callback, notnull Revision revision)
 Load revision's dependency list.
 
proto native Revision GetLocalRevision ()
 Get local (non-workshop) revision.
 
proto native string Summary ()
 Get summary.
 
- Public Member Functions inherited from BaseWorkshopItem
proto native string Name ()
 
proto native string Description ()
 

Static Public Member Functions

static proto native WorldSaveItem CreateLocalWorldSave (notnull WorldSaveManifest manifest)
 
- Static Public Member Functions inherited from WorkshopItem
proto static native void SetThumbnailGridScale (int scale)
 Set the prefed thumbnail size (width) that is automatically downloaded when called RequestPage.
 

Member Function Documentation

◆ CreatedAt()

proto native int WorldSaveItem.CreatedAt ( )

◆ CreateLocalWorldSave()

static proto native WorldSaveItem WorldSaveItem.CreateLocalWorldSave ( notnull WorldSaveManifest  manifest)
static

◆ DeleteOffline()

proto native void WorldSaveItem.DeleteOffline ( )

◆ DeleteOnline()

proto native void WorldSaveItem.DeleteOnline ( BackendCallback  callback)

Request delete of this item from the backend storage.

◆ FillManifest()

proto native void WorldSaveItem.FillManifest ( out notnull WorldSaveManifest  manifest)

◆ Save()

proto native void WorldSaveItem.Save ( notnull WorldSaveManifest  manifest)

◆ UploadWorldSave()

proto native WorldSaveItem WorldSaveItem.UploadWorldSave ( notnull WorldSaveManifest  manifest,
BackendCallback  callback 
)

The documentation for this interface was generated from the following file: