Player
Public Methods
static Player getInstance()
Get the instance of the Player class.
string getDickSizeString()
Get string representation of player's dick size
void tfDickLarger()
Increase the size of player's dick. This outputs text to screen.
number getHeight()
Player's height, in inches
number getDickSize()
Player's dick size, in inches. 0 = no dick
deleteItem
getName
isInInventory
number getVaginaSize()
In inches. 0 = no vagina
string getVaginaSizeString()
A string representation of the player's vagina, ie: "large slit"
If no vagina (size 0), returns ""
Sizes 7+ are monstrous vaginas -- can check this via getMonsterVagina()
number getWeight()
Returns weight where 0 thin-100 obese.
Will get the larger of either players 'overweight' value (fat) or their pregnancy weight value
string getWeightString()
ie, "lean", "heavy", "obese", etc
This ONLY refers to fat.
int getBreastRows()
Number of rows. 1 is normal for male and female
int getBreastSize()
0 = none, 1 = AA, 2 = A, 3= B, 4=C, 5=D, ...
string getBreastSizeString
String representation of player's breast size, ie "large D-cup hooters"
No breasts will return ""
void tfBreastsLarger(boolean silent)
Increases size of breasts.
silent: If true, does not output TF text to screen.
void tfBreastsSmaller()
Decreases size of breasts. Outputs TF text to screen.
void tfDickLarger()
Increases size of dick (max size via this function is 13). Outputs TF text to screen. Player's lust increases by 20.
void tfDickSmaller()
Decreases size of dick (down to no dick). Outputs TF text to screen.
void setDickSize (int dickSize)
Sets dick size (in inches), with no text output to screen
location getLocation()
Returns players current location
boolean pickupItem(entity entityToPickUp)
This is the main function to call to try adding an item to the player's inventory.
Attempts adding a particular item to the player's inventory. Will fail if inventory is full or there is already a clothing item in the particular slot. A message will be shown to the player describing the success or failure
Returns if item was picked up
void forcePickupItemSilent(entity entityToPickUp)
Forces an item into inventory -- ignores inventory size limit, pickup restrictions, etc.
void pickupItemOrDropToGround(entity entityToPickup)
Attempts to add item to player inventory. If it can't be added, then the item drops to ground at player's feet
int getCurrentInventorySize()
How many items player is carrying -- does NOT include clothing/worn items.
void dropAllInventoryToMapRoom(string mapName, int mapRoomID)
Drops ALL items in the player's inventory into the target map room ID
boolean isInInventoryString(entity entityToCheck)
Is the target object in player inventory currently?
entity getInventoryItemByString(string entityName)
Return the named item (or null, if item name is not in inventory)
void deleteInventoryString(string entityName)
Delete by item's title in inventory
boolean dropItem(entity entityToDrop)
This is the main function to call to try dropping an item out of the player's inventory.
Will fail if item is nonexistent, or item's check function fails (ie: cursed).
A message will be shown to the player describing the success or failure
boolean dropItemForceSilent(entity entityToDrop)
Will silently drop the target item to ground -- regardless of cursed status.
void causeDamage(int damageAmount)
Cause damage to player of damageAmount
int getPlayerAttackDamagePhysical()
How much damage the player causes to monsters. You probably don't need to access this -- usually let existing monster mod system handle combat.
int getPlayerAttackDamageLust()
How much damage the player causes to monsters. You probably don't need to access this -- usually let existing monster mod system handle combat.
int getAcceptance()
Returns player's current acceptance level
void setAcceptance(int newAcceptanceLevel)
Sets player's acceptance level to something new.
void incAcceptance(int amount)
Increases player's acceptance by amount
void decAcceptance(int amount)
Decreases player's acceptance by amount
boolean isCovered(string clothingSlot)
Checks to see if the target clothing slot is covered with an article of clothing that will conceal TFs
Some clothing does NOT conceal TFs (like Lizland bindings)
int getExposure()
How exposed is player?
- < 30 totally safe
- 30 ~ 100 suspicious, will catch looks but is still (currently) safe in public overworld areas
- > 100 guaranteed exposure
boolean getTotallyHuman()
Is player 100% human?
void setTotallyHuman()
Become human - no text output to screen
void setToStartingCharacteristics()
Silently reset player to their starting characteristics, including human and body type
void setMaleSilent()
Player silently becomes male
boolean tfMakeVagina()
Attempts TF. Returns true if player is given a vagina, otherwise player already has one
boolean tfVaginaSmaller()
Attempts TF. Returns true if player's vagina size decreases, otherwise already has no vagina.
boolean tfVaginaLarger()
Attempts TF. Returns true if player's vagina size increases, otherwise already has max size vagina.
void setVaginaSize(int vaginaSize)
Silently set vagina to target size
boolean getMonsterVagina()
Does player have a monstrously sized vagina? (With a monster vagina, players can't climax without receiving monster-sized dick)
void resetLust()
Reset lust, display message
void resetLustSilent()
Reset lust, don't display message
void resetLustButNotMilk()
Reset lust, display message
int getLust()
Returns player lust level
void incLust(int amount)
Increases player lust by amount
void decLust(int amount)
Decreases player lust by amount
string getSomethingToPlayWith()
Gets an action that player or another character could perform against player, depending on what bits they have.
examples:
- "brushing up against your average B-cup boobs"
- "rubbing your large member"
Fairly limited set of generated actions, so use sparingly.
boolean hasArms()
Does the player have arms?
boolean hasLegs()
Does the player have legs?
boolean hasUselessHands()
The player has hands, but they're useless (ie, cow hoof hands)
void incOverweight(int amount)
Increases player's overweightedness, outputs appropriate description text. Outputs one line of text, no newlines. May not output anything if change was not dramatic enough.
Intended for use with weight TF, pregnancy TF should use pregnancy functions!
void decOverweight(int amount)
Decreases player's overweightedness, outputs appropriate description text. Outputs one line of text, no newlines. May not output anything if change was not dramatic enough.
Intended for use with weight TF, pregnancy TF should use pregnancy functions!
int getOverweight()
Gets overweightness (0 ~ 100). This is independent of any pregnancy weight (usually when checking player belly size, you should use getCombinedBellySize!)
incBellyPreg
TODO - not yet exposed as preg system need to be exposed to modding
setBellyPreg
TODO - not yet exposed as preg system need to be exposed to modding
int getCombinedBellySize()
A player's belly will be the larger of their overweightness or bellypreg. 0 = perfectly thin, 100=huge.
getBellyDescription
A few word description of the player's belly (includes both preg & weight factors)
ex: "20 lb noticeably bulging belly"
getBellyPreg
0<->100 size of belly due to pregnancy. 0 = perfectly thin. 100=huge. Also an indication of stage of preg.
(usually when checking player belly size, you should use getCombinedBellySize!)
int getHP()
Returns health points. 0 = dead
int getHPMax()
Returns the highest player HP can reach. Increases on level up.
void heal(int amount)
Heal player by amount. Won't go over HP Max
int getLevel()
Returns player's current level
int getCash()
Returns player's available cash
void addCash(int amount)
Outputs a note that cash was added, and adds cash
boolean removeCash(int amount)
Deducts amount cash if the player has it and returns true, else returns false.
This can be useful for shops, transactions, etc (only deducts if whole amount is there)
string getHeightString()
example: 6' 1"
boolean tfHeightTaller(int amount)
Increase size by number of inches
Returns true if any TF took place