Modding:Player - Revision history

SkyCorp: added optional parameter to dropItem

2026-02-27T08:57:54Z

added optional parameter to dropItem

← Older revision		Revision as of 08:57, 27 February 2026
Line 125:		Line 125:
	Delete by item's title in inventory		Delete by item's title in inventory

	=== boolean dropItem([[Entity]] entityToDrop) ===		=== boolean dropItem([[Entity]] entityToDrop, bool silentTest=false) ===
	This is the main function to call to try dropping an item out of the player's inventory.		This is the main function to call to try dropping an item out of the player's inventory.

Line 131:		Line 131:

	A message will be shown to the player describing the success or failure		A message will be shown to the player describing the success or failure

			silentTest allows the method to be silently tested without actually dropping the item or outputting the text

			(this method also checks wrist bound state, etc)

	=== boolean dropItemForceSilent([[Entity]] entityToDrop) ===		=== boolean dropItemForceSilent([[Entity]] entityToDrop) ===

SkyCorp: Two additional/optional parameters added to pickupItem(...)

2026-02-25T03:12:24Z

Two additional/optional parameters added to pickupItem(...)

← Older revision		Revision as of 03:12, 25 February 2026
Line 89:		Line 89:
	(Added in r26)		(Added in r26)

	=== boolean pickupItem([[Entity]] entityToPickUp) ===		=== boolean pickupItem([[Entity]] entityToPickUp, bool silent=false, bool allowEvenIfWristsBound=false) ===
	This is the main function to call to try adding an item to the player's inventory.		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		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. Normally, a message will be shown to the player describing the success or failure

			'''silent''' - prevents any output from being displayed

			'''allowEvenIfWristsBound''' - allow pickup even if normally player wouldn't be able to pick it up due to bound wrists

			Enabling both silent + allowEvenIfWristsBound is a good combination for situations like NPC putting a collar on the player, where you would want the normal pickup's logic to block the pickup if a collar is already present. Then you can check the result and output to the screen some custom text about the NPC putting the item on the player.

	Returns if item was picked up		Returns if item was picked up

SkyCorp: documentation for getOwner / setOwner

2025-12-20T02:02:25Z

documentation for getOwner / setOwner

← Older revision		Revision as of 02:02, 20 December 2025
Line 432:		Line 432:

	(This is useful since normally in permanent pure mode and a locked TF, the monsters would not TF you at all. By calling this after non-TF defeat sex, it can advance the player's TF a little bit so there is still some progression of the TF.)		(This is useful since normally in permanent pure mode and a locked TF, the monsters would not TF you at all. By calling this after non-TF defeat sex, it can advance the player's TF a little bit so there is still some progression of the TF.)

			=== [[Modding:Entity\|Entity]] getOwner() ===
			(introduced in r56.1)

			Gets the entity the player is owned by -- may return null/nil if no owner.

			=== void setOwner([[Modding:Entity\|Entity]] entity) ===
			(introduced in r56.1)

			Silently sets the entity the player is owned by. Usually you would want to use the Claim Ownership Scene instead of calling this directly so as to give the player a chance to accept/reject, as well as see the dom's stats, dialog, etc.

	== Example Code ==		== Example Code ==
	[[Dick Size Increaser]]		[[Dick Size Increaser]]
	[[Category:LUA Class Reference]]		[[Category:LUA Class Reference]]

SkyCorp: New function: setNameOverride

2025-12-09T02:13:46Z

New function: setNameOverride

← Older revision		Revision as of 02:13, 9 December 2025
Line 22:		Line 22:
	=== string getName() ===		=== string getName() ===
	Gets player's name.		Gets player's name.

			=== void setNameOverride(string nameOverride) ===
			Force players name to something else. Call with "" to set back to normal.

			(Name overrides ignore player gender)

			Added in r56.10

	=== boolean isInInventory([[Entity]] entityToCheck) ===		=== boolean isInInventory([[Entity]] entityToCheck) ===

SkyCorp: SkyCorp moved page Player to Modding:Player

2025-06-17T07:23:34Z

SkyCorp moved page Player to Modding:Player

← Older revision

Revision as of 07:23, 17 June 2025

SkyCorp: void advanceRedirectedTransformation()

2025-05-20T23:58:34Z

void advanceRedirectedTransformation()

← Older revision		Revision as of 23:58, 20 May 2025
Line 418:		Line 418:

	If pregnant, scale back pregnancy a little so we don't immediately have to lay eggs (Call after losing a fight, etc)		If pregnant, scale back pregnancy a little so we don't immediately have to lay eggs (Call after losing a fight, etc)

			=== void advanceRedirectedTransformation() ===
			(Introduced in r56)

			Advances the player's destined transformation (if any). Typically called on monster defeating the player, if the player is not otherwise being transformed from a sequence.

			(This is useful since normally in permanent pure mode and a locked TF, the monsters would not TF you at all. By calling this after non-TF defeat sex, it can advance the player's TF a little bit so there is still some progression of the TF.)

	== Example Code ==		== Example Code ==
	[[Dick Size Increaser]]		[[Dick Size Increaser]]
	[[Category:LUA Class Reference]]		[[Category:LUA Class Reference]]

SkyCorp: /* int getBellyFat() */

2024-06-22T05:26:41Z

int getBellyFat()

← Older revision		Revision as of 05:26, 22 June 2024
Line 234:		Line 234:
	=== int getBellyFat() ===		=== int getBellyFat() ===
	Gets how many pounds of weight on player's belly is caused by fat / how heavy the belly is due to fat. This is independent of any preg (usually you should use getBellyTotalWeight!) 0 = perfectly thin, 100 or more = huge.		Gets how many pounds of weight on player's belly is caused by fat / how heavy the belly is due to fat. This is independent of any preg (usually you should use getBellyTotalWeight!) 0 = perfectly thin, 100 or more = huge.

			Note that while only belly fat is tracked, it's considered representative of the overall overweightedness of a character. So increasing belly fat will cause arms to get flabby, etc.

	=== incBellyPreg ===		=== incBellyPreg ===

SkyCorp: Rename some modding weight functions for consistency

2024-06-22T05:23:07Z

Rename some modding weight functions for consistency

← Older revision		Revision as of 05:23, 22 June 2024
Line 220:		Line 220:
	The player has hands, but they're useless (ie, cow hoof hands)		The player has hands, but they're useless (ie, cow hoof hands)

	=== void ~~incOverweight~~(int amount, bool hyper=false) ===		=== void incBellyFat(int amount, bool hyper=false) ===
	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.		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.

Line 227:		Line 227:
	Optional hyper mode will allow overweight to increase beyond normal limits, which can cause player to get stuck.		Optional hyper mode will allow overweight to increase beyond normal limits, which can cause player to get stuck.

	=== void ~~decOverweight~~(int amount) ===		=== void decBellyFat(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.		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!		Intended for use with weight TF, pregnancy TF should use pregnancy functions!

	=== int ~~getOverweight~~() ===		=== int getBellyFat() ===
	Gets ~~overweightness (0 ~ 100)~~. This is independent of any ~~pregnancy weight~~ (usually ~~when checking player belly size,~~ you should ~~use getCombinedBellySize~~!)		Gets how many pounds of weight on player's belly is caused by fat / how heavy the belly is due to fat. This is independent of any preg (usually you should use getBellyTotalWeight!) 0 = perfectly thin, 100 or more = huge.

	=== incBellyPreg ===		=== incBellyPreg ===
Line 249:		Line 249:
	Does not actually cause player to become pregnant if they are not already.		Does not actually cause player to become pregnant if they are not already.

	=== int ~~getCombinedBellySize~~() ===		=== int getBellyTotalWeight() ===
	A player's ~~belly~~ will be the larger of their ~~overweightness or bellypreg~~. ~~0 = perfectly thin~~, ~~100=huge~~.		Gets how heavy the belly is over a normal weight. 0 thin-100 overweight (or more!)

			This is typically the function it is recommended to use when checking player's weight (ex: mobility flavor text, etc)

			Usually, this will get the larger of players fat (bellyFat) value or their pregnancy weight value. However, players MAY have enabled to combine these two numbers for added difficulty. To check only fat, use getBellyFatOnly()

	=== string getBellyDescription() ===		=== string getBellyDescription() ===

SkyCorp: Additional optional parameters for Player class

2023-06-27T05:32:31Z

Additional optional parameters for Player class

← Older revision		Revision as of 05:32, 27 June 2023
Line 172:		Line 172:
	Attempts TF. Returns true if player's vagina size decreases, otherwise already has no vagina.		Attempts TF. Returns true if player's vagina size decreases, otherwise already has no vagina.

	=== boolean tfVaginaLarger() ===		=== boolean tfVaginaLarger(bool silent=false) ===
	Attempts TF. Returns true if player's vagina size increases, otherwise already has max size vagina.		Attempts TF. Returns true if player's vagina size increases, otherwise already has max size vagina.

			Silent parameter will make the transformation not display any output on screen.

	=== void setVaginaSize(int vaginaSize) ===		=== void setVaginaSize(int vaginaSize) ===
Line 193:		Line 195:
	Returns player lust level		Returns player lust level

	=== void incLust(int amount) ===		=== void incLust(int amount, bool silent=false) ===
	Increases player lust by amount		Increases player lust by amount

			Silent parameter (optional) will make the transformation not display any output on screen.

	=== void decLust(int amount) ===		=== void decLust(int amount) ===
Line 216:		Line 220:
	The player has hands, but they're useless (ie, cow hoof hands)		The player has hands, but they're useless (ie, cow hoof hands)

	=== void incOverweight(int amount) ===		=== void incOverweight(int amount, bool hyper=false) ===
	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.		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!		Intended for use with weight TF, pregnancy TF should use pregnancy functions!

			Optional hyper mode will allow overweight to increase beyond normal limits, which can cause player to get stuck.

	=== void decOverweight(int amount) ===		=== void decOverweight(int amount) ===

SkyCorp: dropAllInventoryToMapRoom added third parameter in r38

2019-07-01T04:24:18Z

dropAllInventoryToMapRoom added third parameter in r38

← Older revision		Revision as of 04:24, 1 July 2019
Line 98:		Line 98:
	How many items player is carrying -- does NOT include clothing/worn items.		How many items player is carrying -- does NOT include clothing/worn items.

	=== void dropAllInventoryToMapRoom(string mapName, int mapRoomID) ===		=== void dropAllInventoryToMapRoom(string mapName, int mapRoomID, [bool removeTattoosAndPiercings]) ===
	Drops ALL items in the player's inventory into the target map room ID		Drops ALL items in the player's inventory into the target map room ID.

			In r38+, an optional third parameter is available to set whether tattoos and piercings should also be removed.

	=== boolean isInInventoryString(string entityName) ===		=== boolean isInInventoryString(string entityName) ===