Difference between revisions of "Cabal Common Library OXP"
(reinstated the image) |
m (added new docs) |
||
Line 1: | Line 1: | ||
+ | [[Image:CCL_logo.png|150px|right]] | ||
==Overview== | ==Overview== | ||
− | + | Reinventing the wheel is not everybodys taste, so here comes a collection of useful snippets and helpers. | |
Its main purpose is to simplify some common tasks used by OXPers and also includes a few unique features. It contains functions to check requirements, helper functions for arrays, strings, and numbers, an encrypt/decrypt algorithm, and, last but not least, functions for missionscreen models, an onscreen keyboard, a comms channel, special market deals, a event driven script for music and a tool to check the player ship and NPCs. Over time it will grow and include more functions and features. The library does not alter any native JS objects (like Array or String) in its current form to avoid clashes. | Its main purpose is to simplify some common tasks used by OXPers and also includes a few unique features. It contains functions to check requirements, helper functions for arrays, strings, and numbers, an encrypt/decrypt algorithm, and, last but not least, functions for missionscreen models, an onscreen keyboard, a comms channel, special market deals, a event driven script for music and a tool to check the player ship and NPCs. Over time it will grow and include more functions and features. The library does not alter any native JS objects (like Array or String) in its current form to avoid clashes. | ||
Line 7: | Line 8: | ||
The current internal version is {{CCL_Int}}. | The current internal version is {{CCL_Int}}. | ||
+ | * [[Cabal_Common_Library_Doc_2DCollision|Cabal_Common_2DCollision]], 2D checks | ||
* [[Cabal_Common_Library_Doc_BinSearch|Cabal_Common_BinSearch]], binary search tree | * [[Cabal_Common_Library_Doc_BinSearch|Cabal_Common_BinSearch]], binary search tree | ||
* [[Cabal_Common_Library_Doc_Briefing|Cabal_Common_Briefing]], enhance mission screens | * [[Cabal_Common_Library_Doc_Briefing|Cabal_Common_Briefing]], enhance mission screens | ||
Line 12: | Line 14: | ||
* [[Cabal_Common_Library_Doc_Functions|Cabal_Common_Functions]], generic function library | * [[Cabal_Common_Library_Doc_Functions|Cabal_Common_Functions]], generic function library | ||
* [[Cabal_Common_Library_Doc_Keyboard|Cabal_Common_Keyboard]], user input | * [[Cabal_Common_Library_Doc_Keyboard|Cabal_Common_Keyboard]], user input | ||
+ | * [[Cabal_Common_Library_Doc_MissionHandling|Cabal_Common_MissionHandling]], start OXPs based on system descriptions | ||
* [[Cabal_Common_Library_Doc_Music|Cabal_Common_Music]], inflight event driven music | * [[Cabal_Common_Library_Doc_Music|Cabal_Common_Music]], inflight event driven music | ||
* [[Cabal_Common_Library_Doc_SpecialMarkets|Cabal_Common_SpecialMarkets]], trading special goods | * [[Cabal_Common_Library_Doc_SpecialMarkets|Cabal_Common_SpecialMarkets]], trading special goods | ||
Line 30: | Line 33: | ||
* Dr.J R Stockton (rand, randSpan, msbPos, baseChange, strLZ, strLZZ, arrShuffle), | * Dr.J R Stockton (rand, randSpan, msbPos, baseChange, strLZ, strLZZ, arrShuffle), | ||
* Nicholas Zakas (Cabal_Common_BinSearch is based on his ideas) | * Nicholas Zakas (Cabal_Common_BinSearch is based on his ideas) | ||
+ | * Paul Bourke (pointOnLineB) | ||
==Requirements== | ==Requirements== |
Revision as of 11:39, 16 March 2012
Overview
Reinventing the wheel is not everybodys taste, so here comes a collection of useful snippets and helpers.
Its main purpose is to simplify some common tasks used by OXPers and also includes a few unique features. It contains functions to check requirements, helper functions for arrays, strings, and numbers, an encrypt/decrypt algorithm, and, last but not least, functions for missionscreen models, an onscreen keyboard, a comms channel, special market deals, a event driven script for music and a tool to check the player ship and NPCs. Over time it will grow and include more functions and features. The library does not alter any native JS objects (like Array or String) in its current form to avoid clashes.
Features
The current internal version is 15.
- Cabal_Common_2DCollision, 2D checks
- Cabal_Common_BinSearch, binary search tree
- Cabal_Common_Briefing, enhance mission screens
- Cabal_Common_Comms, inflight communication
- Cabal_Common_Functions, generic function library
- Cabal_Common_Keyboard, user input
- Cabal_Common_MissionHandling, start OXPs based on system descriptions
- Cabal_Common_Music, inflight event driven music
- Cabal_Common_SpecialMarkets, trading special goods
- Cabal_Common_Strength, environment control
With contributions from:
- Michael Werle (documentation),
- Ahruman (pseudoRand),
- Commander McLane (strDateFromMinutes),
- Eric Walch (mapCoordsDirection),
- Terry Yuen (en/decryption),
- Dr.J R Stockton (rand, randSpan, msbPos, baseChange, strLZ, strLZZ, arrShuffle),
- Nicholas Zakas (Cabal_Common_BinSearch is based on his ideas)
- Paul Bourke (pointOnLineB)
Requirements
- Oolite v1.76.
Download
- Cabal_Common_Library1.5.zip - (996.1 KB)
Documentation for OXP Developers:
A short demo for the mission briefing tool:
- Cabal_Common_Briefing_Demo1.4.1.zip - (333.2 KB)
Quick Facts
Version | Released | License | Features | Category | Author(s) | Feedback |
---|---|---|---|---|---|---|
1.5 | 2011-12-17 | CC-by | Helper, Images, Sounds, Equipment |
Misc OXPs | Cmd.Cheyd PhantorGorth Svengali |
BB-Link |