fly/fgdata
1
0
Fork 0
Code Activity

Docs/README.add-ons: add documentation for addons.Addon.resourcePath()

Browse source
This commit is contained in:
Florent Rougon 2018-01-10 14:13:25 +01:00
parent ab8774a3e0
commit acd54efff7
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
Docs/README.add-ons
View file

@ -547,6 +547,21 @@ Read-only data members (attributes) of addons.Addon objects:
loadSequenceNumber 0 for the first registered add-on, 1 for the
second one, etc. (integer)
Member functions (methods) of addons.Addon objects:
resourcePath(string relPath) -> string
Return a resource path suitable for use with the
simgear::ResourceManager. 'relPath' must be
relative to the add-on base directory, and
mustn't start with a '/'. You should use this
method to load for instance a property-rule
configuration file, or an image to display in a
Canvas widget.
In you want a full path to the resource file
(e.g., for troubleshooting), call resolvepath()
with the return value of addons.Addon.resourcePath().
Read-only data members (attributes) of addons.AddonVersion objects:
majorNumber non-negative integer