Skip to content
This repository was archived by the owner on Nov 28, 2018. It is now read-only.

OneVersion_ReportAddonInfo event

Jay Reardon edited this page Jun 9, 2015 · 25 revisions

This event is how OneVersion gets your add-on's information about version and type.

   Event_FireGenericEvent("OneVersion_ReportAddonInfo", AddonName, Major, Minor, Patch, Suffix, IsLibrary)
Parameter Required Type Description
AddonName Yes String The name of your add-on.
Major Yes Number The major version number of your add-on.
Minor No Number The minor version number of your add-on. Default value is 0
Patch No Number The patch version number of your add-on. Default value is 0
Suffix No Number An enumerated value which corresponds to the [[Suffixes
IsLibrary No Boolean Is this a library? (true/false) Default value is false.

Completed Version numbers are constructed from the individual parts in the form: Major.Minor.Patch(Suffix) So, if you provide the values Major=1, Minor=2, Patch=3, Suffix=4; then the resulting version will be "1.2.3d"

Note: If either the AddonName or Major version numbers are nil, then OneVersion ignores the request and does nothing with the event. If the Minor, Patch, or Suffix are nil, then they are defaulted to 0 instead. If IsLibrary is nil, then it is defaulted to false. OneVersion will attempt to convert these values to the correct type. If they can not be converted then the default values will be used.

A Sample Addon is available to see how this is done.

Using Version Suffixes

If your add-on uses a suffix designation, then this can also be passed to OneVersion by providing a Suffix value from the list below. Suffixes still treated as numeric values that have a replacement string to maintain version comparison.

When invoking the Generic event, you should instead invoke it as so:

   Event_FireGenericEvent("OneVersion_ReportAddonInfo", "YourAddon", 1, 1, 1, 1)

If no suffix value is passed, then the value of 0 is assumed.

Reporting Library Versions

OneVersion also supports the ability to track library version as well. This is done by passing the IsLibrary parameter as true. Since libraries don't generally have an OnDocLoaded or OnInterfaceMenuListHasLoaded event the event can be invoked during the OnLoad event for both embedded and loaded libraries.

This should be invoked as so:

   Event_FireGenericEvent("OneVersion_ReportAddonInfo", "YourLibrary", 1, 1, 1, 0, true)

Suffix List

Value Suffix Enum
-2 α OneVersion.CodeEnumAddonSuffixLevel.Alpha
-1 β OneVersion.CodeEnumAddonSuffixLevel.Beta
0 OneVersion.CodeEnumAddonSuffixLevel.None
1 a OneVersion.CodeEnumAddonSuffixLevel.LetterA
2 b OneVersion.CodeEnumAddonSuffixLevel.LetterB
3 c OneVersion.CodeEnumAddonSuffixLevel.LetterC
4 d OneVersion.CodeEnumAddonSuffixLevel.LetterD
5 e OneVersion.CodeEnumAddonSuffixLevel.LetterE
6 f OneVersion.CodeEnumAddonSuffixLevel.LetterF
7 g OneVersion.CodeEnumAddonSuffixLevel.LetterG
8 h OneVersion.CodeEnumAddonSuffixLevel.LetterH
9 i OneVersion.CodeEnumAddonSuffixLevel.LetterI
10 j OneVersion.CodeEnumAddonSuffixLevel.LetterJ
11 k OneVersion.CodeEnumAddonSuffixLevel.LetterK
12 l OneVersion.CodeEnumAddonSuffixLevel.LetterL
13 m OneVersion.CodeEnumAddonSuffixLevel.LetterM
14 n OneVersion.CodeEnumAddonSuffixLevel.LetterN
15 o OneVersion.CodeEnumAddonSuffixLevel.LetterO
16 p OneVersion.CodeEnumAddonSuffixLevel.LetterP
17 q OneVersion.CodeEnumAddonSuffixLevel.LetterQ
18 r OneVersion.CodeEnumAddonSuffixLevel.LetterR
19 s OneVersion.CodeEnumAddonSuffixLevel.LetterS
20 t OneVersion.CodeEnumAddonSuffixLevel.LetterT
21 u OneVersion.CodeEnumAddonSuffixLevel.LetterU
22 v OneVersion.CodeEnumAddonSuffixLevel.LetterV
23 w OneVersion.CodeEnumAddonSuffixLevel.LetterW
24 x OneVersion.CodeEnumAddonSuffixLevel.LetterX
25 y OneVersion.CodeEnumAddonSuffixLevel.LetterY
26 z OneVersion.CodeEnumAddonSuffixLevel.LetterZ

Clone this wiki locally