Differences

This shows you the differences between two versions of the page.

--- libtf:documentation:api:inventory [2018/02/25 10:42] – lee
+++ libtf:documentation:api:inventory [2018/09/24 18:07] (current) – removed lee
@@ Line 1: / Line 1: @@
-[[libtf:documentation:api:start|<-- Back]]
-====== LibTF.Something======
-**Inherits From:** [[libtf:documentation:api:persistentobject|LibTF.PersistentObject]]
-Blurb.
-===== Fields =====
-**Inherited from [[libtf:documentation:api:persistentobject|LibTF.PersistentObject]]:** id, parentId, parent, name, aName, nameIsProper, nameIrregularArticle
-===== Methods =====
-**Inherited from [[libtf:documentation:api:persistentobject|LibTF.PersistentObject]]:** hasPersistent(), getPersistent(), setPersistent(), resetPersistent()
-==== (SomeClass).someMethod( arg ) ====
-  * **Arguments:**
-    * **//arg://** a thing.
-  * **Returns:** (Type)  Details.
-  * **Throws:** Error if: Stuff.
-Description.
-<code javascript>
-add( itemOrId )
-	{
-		var id = validateItemOrId( "add", itemOrId );
-		if( !this.has(id) )
-		{
-			var pre = this.preAdd( id );
-			if( pre != true && pre != false )
-				doThrow( "add", "preAdd() did not return boolean!" );
-			if( pre )
-			{
-				var inventory = Persistence.get( this.id ) || [];
-				inventory.push( id );
-				Persistence.set( this.id, inventory );
-				this.postAdd( id );
-			}
-		}
-	}
-</code>
-==== (SomeClass).someMethod( arg ) ====
-  * **Arguments:**
-    * **//arg://** a thing.
-  * **Returns:** (Type)  Details.
-  * **Throws:** Error if: Stuff.
-Description.
-<code javascript>
-remove( itemOrId )
-	{
-		var id = validateItemOrId( "remove", itemOrId );
-		var pre = this.preRemove( id );
-		if( pre != true && pre != false )
-			doThrow( "remove", "preRemove() did not return boolean!" );
-		if( pre )
-		{
-			var inventory = Persistence.get( this.id ) || [];
-			var pos;
-			while( (pos=$.inArray(id,inventory)) >= 0 )
-				inventory.splice(pos,1);
-			Persistence.set( this.id, inventory );
-			this.postRemove( id );
-		}
-	}
-</code>
-==== (SomeClass).someMethod( arg ) ====
-  * **Arguments:**
-    * **//arg://** a thing.
-  * **Returns:** (Type)  Details.
-  * **Throws:** Error if: Stuff.
-Description.
-<code javascript>
-has( itemOrId )
-	{
-		var id = validateItemOrId( "has", itemOrId );
-		var inventory = Persistence.get( this.id ) || [];
-		return $.inArray(id,inventory) >= 0;
-	}
-</code>
-==== (SomeClass).someMethod( arg ) ====
-  * **Arguments:**
-    * **//arg://** a thing.
-  * **Returns:** (Type)  Details.
-  * **Throws:** Error if: Stuff.
-Description.
-<code javascript>
-get()
-	{
-		var inventory = Persistence.get( this.id ) || [];
-		let a = [];
-		for( let i=0; i<inventory.length; i++ )
-			a.push( Persistence.instantiate(inventory[i]) );
-		return a.sort( this.sort);
-	}
-</code>
-==== (SomeClass).someMethod( arg ) ====
-  * **Arguments:**
-    * **//arg://** a thing.
-  * **Returns:** (Type)  Details.
-  * **Throws:** Error if: Stuff.
-Description.
-<code javascript>
-getListString( examineLink = true )
-	{
-		let l = [];
-		for( let a of this.get() )
-		{
-			let examinePassage = "Examine."+a.id;
-			if( examineLink && Story.has(examinePassage) )
-				l.push( "[["+a.aName+"->"+examinePassage+"]]" );
-			else
-				l.push( a.aName );
-		}
-		return Util.commaList( l );
-	}
-</code>
-==== (SomeClass).someMethod( arg ) ====
-  * **Arguments:**
-    * **//arg://** a thing.
-  * **Returns:** (Type)  Details.
-  * **Throws:** Error if: Stuff.
-Description.
-<code javascript>
-sort( a, b )
-	{
-		return a.name.toLowerCase().localeCompare( b.name.toLowerCase() );
-	}
-</code>
-==== (SomeClass).someMethod( arg ) ====
-  * **Arguments:**
-    * **//arg://** a thing.
-  * **Returns:** (Type)  Details.
-  * **Throws:** Error if: Stuff.
-Description.
-<code javascript>
-preAdd( id )
-	{
-		return true;
-	}
-</code>
-==== (SomeClass).someMethod( arg ) ====
-  * **Arguments:**
-    * **//arg://** a thing.
-  * **Returns:** (Type)  Details.
-  * **Throws:** Error if: Stuff.
-Description.
-<code javascript>
-postAdd( id )
-	{
-	}
-</code>
-==== (SomeClass).someMethod( arg ) ====
-  * **Arguments:**
-    * **//arg://** a thing.
-  * **Returns:** (Type)  Details.
-  * **Throws:** Error if: Stuff.
-Description.
-<code javascript>
-preRemove( id )
-	{
-		return true;
-	}
-</code>
-==== (SomeClass).someMethod( arg ) ====
-  * **Arguments:**
-    * **//arg://** a thing.
-  * **Returns:** (Type)  Details.
-  * **Throws:** Error if: Stuff.
-Description.
-<code javascript>
-postRemove( id )
-	{
-	}
-</code>
-[[libtf:documentation:api:start|<-- Back]]

Echo Hollow

Echo Hollow

Differences

Echo Hollow

Echo Hollow

User Tools

Site Tools

Differences

Page Tools