Differences

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

--- libtf:documentation:api:person [2018/04/22 19:13] – lee
+++ libtf:documentation:api:person [2024/06/19 20:19] (current) – removed lee
@@ Line 1: / Line 1: @@
-[[libtf:documentation:api:start|<-- Back]]
-====== LibTF.Person======
-**Inherits From:** [[libtf:documentation:api:persistentobject|LibTF.PersistentObject]]
-[[libtf:documentation:api:person|LibTF.Person]] is kind of the core of [[libtf:documentation:api:|LibTF]].  Each character in your can who can be transformed (usually just the PC in most TF games, but the library supports as many transformable characters as you want).
-[[libtf:documentation:api:person|LibTF.Persons]] can carry items, via their [[libtf:documentation:api:inventory|Inventory]] field.
-[[libtf:documentation:api:person|LibTF.Persons]] can wear [[libtf:documentation:api:apparel:|Apparel]], via their [[libtf:documentation:api:apparel:wornapparel|WornApparel]] field.
-[[libtf:documentation:api:person|LibTF.Persons]] also have built in [[libtf:documentation:api:transformable:|Transformable]] fields, which are the core of the library's transformation system.
-===== Fields =====
-**Inherited from [[libtf:documentation:api:persistentobject|LibTF.PersistentObject]]:** id, parentId, parent, name, aName, nameIsProper, nameIrregularArticle
-==== (Person).applyTransformationsImmediately ====
-  * **Access:** Read-Write
-  * **Type:** Boolean
-This field controls whether or not transformations are applied to this Person immediately.
-If true, then any modification of any of this Person's [[libtf:documentation:api:transformable:|Transformable]] fields .val or .newVal fields, as well as calls to .increase() or .decrease(), will be applied to this Person immediately.
-If false, then any modification as above will be deferred until .applyTransformations() is called on this Person, or .applyTransformation() is called on the specific [[libtf:documentation:api:transformable:|Transformable]].  That is, these modifications will be remembered secretly as they are made, but they will not be applied to the Person until .applyTransformations() is called.  This is useful for games where transformations occur as the PC sleeps, as a result of the day's events, or somesuch.
-If null or undefined when Persistence.setDefaults was called to create this Person, then the value of [[libtf:documentation:api:settings#libtfsettingsdefaultapplytransformationsimmediately|LibTF.Settings.defaultApplyTransformationsImmediately]] will be used.
-==== (Person).inventory ====
-  * **Access:** Read-Only
-  * **Type:** LibTF.Inventory
-The [[libtf:documentation:api:inventory|LibTF.Inventory]] object that tracks what items this Person is carrying.
-==== (Person).apparel ====
-  * **Access:** Read-Only
-  * **Type:** LibTF.Apparel.WornApparel
-The [[libtf:documentation:api:apparel:wornapparel|LibTF.Apparel.WornApparel]] object that tracks what this Person is wearing.
-==== (Person).femininity ====
-  * **Access:** Read-Only
-  * **Type:** LibTF.Transformable.Femininity
-FIXME Description.
-==== (Person).height ====
-  * **Access:** Read-Only
-  * **Type:** LibTF.Transformable.Height
-FIXME Description.
-==== (Person).bust ====
-  * **Access:** Read-Only
-  * **Type:** LibTF.Transformable.Bust
-FIXME Description.
-==== (Person).penis ====
-  * **Access:** Read-Only
-  * **Type:** LibTF.Transformable.Penis
-FIXME Description.
-==== (Person).pussy ====
-  * **Access:** Read-Only
-  * **Type:** LibTF.Transformable.Pussy
-FIXME Description.
-===== Methods =====
-**Inherited from [[libtf:documentation:api:persistentobject|LibTF.PersistentObject]]:** hasPersistent(), getPersistent(), setPersistent(), resetPersistent()
-==== (Person).applyChanges( thirdPerson = false ) ====
-  * **Arguments:**
-    * **//thirdPerson://** FIXME.
-  * **Returns:** (type) desc.
-  * **Throws:** Error if: FIXME.
-FIXME desc
-<code javascript>
-FIXME Example
-</code>
-==== (Person).getDescriptionGeneral( thirdPerson=false, suppressTFStats=false ) ====
-  * **Arguments:**
-    * **//thirdPerson://** FIXME.
-    * **//suppressTFStats://** FIXME.
-  * **Returns:** (type) desc.
-  * **Throws:** Error if: FIXME.
-FIXME desc
-<code javascript>
-FIXME Example
-</code>
-==== (Person).getDescriptionApparel( thirdPerson=false, suppressTFStats=false ) ====
-  * **Arguments:**
-    * **//thirdPerson://** FIXME.
-    * **//suppressTFStats://** FIXME.
-  * **Returns:** (type) desc.
-  * **Throws:** Error if: FIXME.
-FIXME desc
-<code javascript>
-FIXME Example
-</code>
-==== (Person).getDescriptionSexual( thirdPerson=false, suppressTFStats=false ) ====
-  * **Arguments:**
-    * **//thirdPerson://** FIXME.
-    * **//suppressTFStats://** FIXME.
-  * **Returns:** (type) desc.
-  * **Throws:** Error if: FIXME.
-FIXME desc
-<code javascript>
-FIXME Example
-</code>
-[[libtf:documentation:api:start|<-- Back]]

Echo Hollow

Echo Hollow

Differences

Echo Hollow

Echo Hollow

User Tools

Site Tools

Differences

Page Tools