Lib PAD - Revision history

Cholmondely: Note about Vector OXP

2021-07-18T19:31:35Z

Note about Vector OXP

Cholmondely: Added Screen Shot

2021-06-01T08:21:54Z

Added Screen Shot

Svengali: Updated the example

2018-10-05T14:22:27Z

Updated the example

Svengali: Added _setPageEntry value ++ convenience

2018-10-04T20:45:16Z

Added _setPageEntry value ++ convenience

Svengali: Added silent parameter

2018-10-04T20:40:33Z

Added silent parameter

Svengali: added parent argument for _addPageInCategory

2018-04-04T18:02:54Z

added parent argument for _addPageInCategory

Svengali: Replaced rank with kills for GALCOP and GUILDS and _getData returns Object or null.

2018-04-02T09:45:32Z

Replaced rank with kills for GALCOP and GUILDS and _getData returns Object or null.

Svengali: Doc part III

2018-03-29T12:21:39Z

Doc part III

Svengali: Doc part II

2018-03-29T08:48:55Z

Doc part II

Svengali: First draft

2018-03-28T17:24:42Z

First draft

New page

[[Image:IconLib.png|100px|right]]
==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===
{{CodeEx|codeex= _addPageInCategory: function( path, content )}}
Register a new page entry in the specified dotted path on [[Oolite_JavaScript_Reference:_World_script_event_handlers#startUpComplete|.startUpComplete]] or later.

'''Parameters:'''
:;path:String.
:;content:Object.

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

===_setPageEntry===
{{CodeEx|codeex= _setPageEntry: function( path, value )}}
Set value in the specified dotted path on [[Oolite_JavaScript_Reference:_World_script_event_handlers#startUpComplete|.startUpComplete]] or later.

'''Parameters:'''
:;path:String.
:;value:Primitive.

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

===_getData===
{{CodeEx|codeex= _getData: function( path )}}
Return the data-object in the specified dotted path on [[Oolite_JavaScript_Reference:_World_script_event_handlers#startUpComplete|.startUpComplete]] or later.

'''Parameters:'''
:;path:String.

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

[[Category:OXPDoc]]

← Older revision		Revision as of 19:31, 18 July 2021
Line 4:		Line 4:
	The P.A.D. on the F4 ship-station interface screen. 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.		The P.A.D. on the F4 ship-station interface screen. 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.

		+	There was an earlier version in [[Vector OXP]].

	==Categories==		==Categories==

@@ Line 89: / Line 89: @@
 this.startUpComplete = function(){
   if(missionVariables.MYMISSIONVARIABLE) this.$data = JSON.parse(missionVariables.MYMISSIONVARIABLE);
-  worldScripts.Lib_PAD._addPageInCategory("GALCOP.GCI",this.$data.GCI);
+  worldScripts.Lib_PAD._addPageInCategory("GALCOP.GCI",this.$data.GCI,0,1);
 };
 this.playerWillSaveGame = function(){

@@ Line 61: / Line 61: @@
 '''Parameters:'''
 :;path:String. Dotted path: [[#Categories|Category]], page identifier and [[#Types|page entry]]. E.g. "GALCOP.NAVY.enlisted".
-:;value:Primitive (String or Number). If the path points to an Array the value will be pushed.
+:;value:Primitive (String or Number). If the path points to an Array the value will be pushed. For kills '''++''' can be used to increase the value by one.
 :;sil:Bool. Add the value silently.

@@ Line 42: / Line 42: @@
 The following entry points for AddOns can be used on [[Oolite_JavaScript_Reference:_World_script_event_handlers#startUpComplete|.startUpComplete]] or later.
 ===_addPageInCategory===
-{{CodeEx|codeex= _addPageInCategory: function( path, content, parent )}}
+{{CodeEx|codeex= _addPageInCategory: function( path, content, parent, sil )}}
 Register a new page entry in the specified dotted path. The inserted Object is cloned and merged with the corresponding template.
@@ Line 49: / Line 49: @@
 :;content:Object.
 :;parent:Array. Pathes to relate to one or more other pages.
 '''Returns:'''
@@ Line 55: / Line 56: @@
 ===_setPageEntry===
-{{CodeEx|codeex= _setPageEntry: function( path, value )}}
+{{CodeEx|codeex= _setPageEntry: function( path, value, sil )}}
 Set value in the specified dotted path.
@@ Line 61: / Line 62: @@
 :;path:String. Dotted path: [[#Categories|Category]], page identifier and [[#Types|page entry]]. E.g. "GALCOP.NAVY.enlisted".
 :;value:Primitive (String or Number). If the path points to an Array the value will be pushed.
 '''Returns:'''

@@ Line 42: / Line 42: @@
 The following entry points for AddOns can be used on [[Oolite_JavaScript_Reference:_World_script_event_handlers#startUpComplete|.startUpComplete]] or later.
 ===_addPageInCategory===
-{{CodeEx|codeex= _addPageInCategory: function( path, content )}}
+{{CodeEx|codeex= _addPageInCategory: function( path, content, parent )}}
 Register a new page entry in the specified dotted path. The inserted Object is cloned and merged with the corresponding template.
@@ Line 48: / Line 48: @@
 :;path:String. Dotted path: [[#Categories|Category]] and page identifier. E.g. "GALCOP.NAVY".
 :;content:Object.
 '''Returns:'''

@@ Line 1: / Line 1: @@
 [[Image:IconLib.png|100px|right]]
 ==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.
+The P.A.D. on the F4 ship-station interface screen. 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.

@@ Line 9: / Line 9: @@
 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. All pages, except LOGS, do have 6 slots for textures (t0 - t5).
 :;GALCOP:Category for GalCop, Police, Navy and other official organisations related to GalCop.
-:::Contains entries: name, entry, rank, enlisted, missions, awards, info.
+:::Contains entries: name, entry, enlisted, kills, missions, awards, info.
-::::name and rank are set by Lib_PAD.
+::::name is set by Lib_PAD.
 :;GUILDS:Category for other organisations which do have a membership.
-:::Contains entries: name, entry, rank, enlisted, missions, awards, info.
+:::Contains entries: name, entry, enlisted, kills, missions, awards, info.
-::::name and rank are set by Lib_PAD.
+::::name is set by Lib_PAD.
 :;INFOS:Category for special events, news, specific stations, etc.
 :::Contains entries: name, location, beacon, purpose, special, notes.
@@ Line 25: / Line 25: @@
 ===Types===
-:;Number: age.
+:;Number: age, kills.
 :;String: beacon, enlisted, entry, gender, location, name, origin, purpose, rank, ship, species.
 :;Array: awards, info, list, missions, notes, special.
@@ Line 73: / Line 73: @@
 '''Returns:'''
-:Object (on success) or '''false''' (if the path does not exist).
+:Object (on success) or '''null''' (if the path does not exist).