Some useful functions for ULib plugins to use for doing plugin-type things.
| Plugin Helpers | Some useful functions for ULib plugins to use for doing plugin-type things. |
| Tables | |
| plugins | Holds plugin data for plugins that have registered themselves with ULib. |
| Functions | |
| registerPlugin | |
| pluginVersionStr | Returns a human-readable version string for plugins in a consistent format. |
| updateCheck | Check for updates for a named plugin at a given URL (usually you will want to use the URL specified in registerPlugin). |
Holds plugin data for plugins that have registered themselves with ULib.
| Name | A string of the name of the plugin. |
| Version | A string or number of the version of the plugin. |
| IsRelease | An optional boolean specifying if this is a release (non-beta) version |
| Author | An optional string of the author of the plugin. |
| URL | An optional string of the URL for the plugin. |
| WorkshopID | An optional number specifying the workshopid for the plugin. |
| BuildNumLocal | An optional number specifying the build number for this plugin. |
| BuildHidden | An optional boolean; if true, the build is not shown in the version string. |
| BuildNumRemoteURL | An optional string specifying the URL to visit to retrieve the latest published build number for the plugin. |
| BuildNumRemoteReceivedCallback | An optional function to callback when the latest published build number is received. |
| WorkshopMounted | A generated boolean which is true only if WorkshopID was specified and that ID is currently mounted. |
| BuildNumRemote | A generated number of the retrieved latest published build number. |
function ULib.registerPlugin( pluginData )
| pluginData | A table of plugin data in the format documented in plugins, above. |
function ULib.pluginVersionStr( name )
Returns a human-readable version string for plugins in a consistent format. The string tells users if they’re using a development build (with build number/date), workshop, or release version.
| name | The string of the plugin name you are querying about. |
A string of the version information for the specified plugin.
function ULib.registerPlugin( pluginData )
Returns a human-readable version string for plugins in a consistent format.
function ULib.pluginVersionStr( name )
Check for updates for a named plugin at a given URL (usually you will want to use the URL specified in registerPlugin).
function ULib.updateCheck( name, url )