This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| libtf:documentation:api:inventory [2018/02/25 10:33] – lee | libtf:documentation:api:inventory [2018/09/24 18:07] (current) – removed lee | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | [[libtf: | ||
| - | |||
| - | ====== LibTF.Something====== | ||
| - | |||
| - | **Inherits From:** [[SomeClass]] | ||
| - | |||
| - | Blurb. | ||
| - | |||
| - | |||
| - | ===== Fields ===== | ||
| - | |||
| - | **Inherited from [[SomeClass]]: | ||
| - | |||
| - | ==== (SomeClass).someField ==== | ||
| - | |||
| - | * **Access:** access. | ||
| - | * **Type:** type. | ||
| - | |||
| - | Description. | ||
| - | |||
| - | |||
| - | ===== Methods ===== | ||
| - | |||
| - | **Inherited from [[SomeClass]]: | ||
| - | |||
| - | ==== (SomeClass).someMethod( arg ) ==== | ||
| - | |||
| - | * **Arguments: | ||
| - | * **// | ||
| - | * **Returns: | ||
| - | * **Throws:** Error if: Stuff. | ||
| - | |||
| - | Description. | ||
| - | |||
| - | <code javascript> | ||
| - | // Example code. | ||
| - | </ | ||
| - | |||
| - | |||
| - | [[libtf: | ||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | <code javascript> | ||
| - | add( itemOrId ) | ||
| - | { | ||
| - | var id = validateItemOrId( " | ||
| - | |||
| - | if( !this.has(id) ) | ||
| - | { | ||
| - | var pre = this.preAdd( id ); | ||
| - | if( pre != true && pre != false ) | ||
| - | doThrow( " | ||
| - | if( pre ) | ||
| - | { | ||
| - | var inventory = Persistence.get( this.id ) || []; | ||
| - | inventory.push( id ); | ||
| - | Persistence.set( this.id, inventory ); | ||
| - | this.postAdd( id ); | ||
| - | } | ||
| - | } | ||
| - | } | ||
| - | |||
| - | remove( itemOrId ) | ||
| - | { | ||
| - | var id = validateItemOrId( " | ||
| - | |||
| - | var pre = this.preRemove( id ); | ||
| - | if( pre != true && pre != false ) | ||
| - | doThrow( " | ||
| - | if( pre ) | ||
| - | { | ||
| - | var inventory = Persistence.get( this.id ) || []; | ||
| - | var pos; | ||
| - | while( (pos=$.inArray(id, | ||
| - | inventory.splice(pos, | ||
| - | Persistence.set( this.id, inventory ); | ||
| - | this.postRemove( id ); | ||
| - | } | ||
| - | } | ||
| - | |||
| - | has( itemOrId ) | ||
| - | { | ||
| - | var id = validateItemOrId( " | ||
| - | |||
| - | var inventory = Persistence.get( this.id ) || []; | ||
| - | return $.inArray(id, | ||
| - | } | ||
| - | |||
| - | get() | ||
| - | { | ||
| - | var inventory = Persistence.get( this.id ) || []; | ||
| - | let a = []; | ||
| - | for( let i=0; i< | ||
| - | a.push( Persistence.instantiate(inventory[i]) ); | ||
| - | return a.sort( this.sort); | ||
| - | } | ||
| - | |||
| - | getListString( examineLink = true ) | ||
| - | { | ||
| - | let l = []; | ||
| - | for( let a of this.get() ) | ||
| - | { | ||
| - | let examinePassage = " | ||
| - | if( examineLink && Story.has(examinePassage) ) | ||
| - | l.push( " | ||
| - | else | ||
| - | l.push( a.aName ); | ||
| - | } | ||
| - | return Util.commaList( l ); | ||
| - | } | ||
| - | |||
| - | sort( a, b ) | ||
| - | { | ||
| - | return a.name.toLowerCase().localeCompare( b.name.toLowerCase() ); | ||
| - | } | ||
| - | |||
| - | preAdd( id ) | ||
| - | { | ||
| - | return true; | ||
| - | } | ||
| - | |||
| - | postAdd( id ) | ||
| - | { | ||
| - | } | ||
| - | |||
| - | preRemove( id ) | ||
| - | { | ||
| - | return true; | ||
| - | } | ||
| - | |||
| - | postRemove( id ) | ||
| - | { | ||
| - | } | ||
| - | </ | ||