Lib PAD

From Elite Wiki
Revision as of 18:24, 28 March 2018 by Svengali (talk | contribs) (First draft)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
IconLib.png

Overview

Lib_PAD (part of Library) is a logbook, mission-log, diary and interface. AddOns can implement data to get important organisations, events, systems or persons exposed to the player in an unified way. It also ships search functionality, a way to customize players data (species, gender, etc) and players can also add own notes.


Categories

The categories in Lib_PAD are the first component of all dotted pathes. Pages in a category do share a template which defines the layout of the page.

GALCOP
Category for GalCop, Police, Navy and other official organisations related to GalCop.
GUILDS
Category for other organisations which do have a membership.
INFOS
Category for special events, news, specific stations, etc.
LOGS
Category for standard events like rescued escape pods, bailed out, fined, etc.
PERSONS
Category for characters you have met or you got infos about.
SYSTEMS
Category for special systems like Leesti, Tianve, Tionisla, etc.


Methods

_addPageInCategory

_addPageInCategory: function( path, content )

Register a new page entry in the specified dotted path on .startUpComplete or later.

Parameters:

path
String.
content
Object.

Returns:

true (on success) or false (if the page already exists).


_setPageEntry

_setPageEntry: function( path, value )

Set value in the specified dotted path on .startUpComplete or later.

Parameters:

path
String.
value
Primitive.

Returns:

true (on success) or false (if the path does not exist).


_getData

_getData: function( path )

Return the data-object in the specified dotted path on .startUpComplete or later.

Parameters:

path
String.

Returns:

Object (on success) or false (if the path does not exist).