SkyCorp Global - User contributions [en]

Modding:Bundles

2026-02-27T19:54:15Z

SkyCorp: Change format for None mods

Bundles are mods that contain multiple mod types within them. (Introduced in r56.1)

== Methods of bundling ==
There are two ways to create bundles:

1) Manually through JSON (forced)

2) Automatically through the mod dependencies system

Generally speaking, manual bundles should only be made if the submods have ''no'' potential use independently. For instance, before bundling a monster and a map manually, consider that another modder might want to use the monster in a custom map, or spawn it in a procedural map. In that case, having each of the monster and the map individually listed in the mod database allows more flexibility for the mods to be used in future ways.

== Mod dependencies bundling (Automatic) ==
This is the easiest and most flexible way of bundling -- each mod can list its own dependencies in the mod portal. Then when the user installs the mod, all dependencies will be installed recursively.

=== Tip: Empty bundles ===
If a mod ''only'' has dependencies but no content itself, it is possible to set the mod json as <code>{ "type": "NONE" }</code> You can then set the dependencies as desired.

This may be useful if you are building a related set of mods but they function independently and wouldn't normally need to depend on each other, but you still want a cohesive way for people to download the entire set together with one download.

== Manual bundling ==
Set the type of the mod to <code>BUNDLE</code>.

=== Syntax ===
<syntaxhighlight lang="json">
{
"type": "BUNDLE",
"includedMods":
[
{
"spawn": true,
"mod":
{ ... }
},
{
"spawn": true,
"mod":
{ ... }
}, ...
]
}
</syntaxhighlight>

=== Parameters ===
<code>includedMods</code> will be an array of sub mods, each one specifies:

* <code>spawn</code> - whether the item or monster should be spawned in the environment
* <code>mod</code> - the submod's json

=== Full example ===
This example bundles the [https://skycorp.global/skyscript/mods/v/20/sample-vending-machine vending machine] and the [https://skycorp.global/skyscript/mods/v/19/sample-soda soda] it dispenses as one combined mod. It only spawns the vending machine, but since the soda is loaded, the vending machine can spawn soda through its lua code.

(In reality, you would not want to bundle these together as by using the automatic dependency system, other mods could make use of the soda entity for their own purposes.)<syntaxhighlight lang="json">
{
"type": "BUNDLE",
"includedMods":
[
{
"spawn": true,
"mod":
{
"type": "ENTITY",
"name":
{
"literalString": "Vending Machine"
},
"description":
{
"literalString": "The vending machine advertises $1 for one diet soda."
},
"doUse":
{
"programBoolean": true
},
"isUseable":
{
"literalBoolean": true
},
"lua": "function doUse()\r\n\t-- NOTE: If creating a full store, it would probably be better to use the\r\n\t-- existing store code, however as of Feb 2018 this is not yet exposed to\r\n\t-- LUA modding. However, this is fine for a 'shop' that only sells one\r\n\t-- item.\r\n\r\n\tplayer = Player.getInstance();\r\n\r\n\tif player.removeCash(1) then\r\n\t\t-- Player has enough currency to cover the transaction, and it was\r\n\t\t-- deducted successfully.\r\n\r\n\t\t-- This matches the id field in entity json. Generally best to use the\r\n\t\t-- same name as your mod wiki page to prevent conflicts between multiple\r\n\t\t-- mods.\r\n\t\tsoda = Entity.generate(\"Sample Soda\");\r\n\r\n\t\tif soda == nil then\r\n\t\t\tMainScreen.addGameText(\"Please also load the Sample Soda mod.\");\r\n\t\telse\r\n\t\t\tMainScreen.addGameText('You insert $1 into the vending machine. ' ..\r\n\t\t\t\t'It spits out a can of diet soda.');\r\n\r\n\t\t\t-- Set location to be the same location as vending machine.\r\n\t\t\t-- Since the player must be next to the vending machine to use it,\r\n\t\t\t-- this function works fine. Another (longer) method would be to get\r\n\t\t\t-- the vending machine's location and set the soda's location to it.\t\t\t\r\n\t\t\tsoda.moveEntityToSameRoomAsPlayer();\r\n\t\tend\r\n\telse\r\n\t\t-- Player didn't have enough currency to cover the total cost of transaction.\r\n\t\t-- No currency was deducted.\r\n\t\t\r\n\t\tMainScreen.addGameText('You need at least $1 to buy a soda.');\t\r\n\tend\r\n\r\n\treturn true; -- Automatic continue scene\r\nend"
}
},
{
"spawn": false,
"mod":
{
"type": "ENTITY",
"id": "Sample Soda",
"name":
{
"literalString": "Soda"
},
"description":
{
"literalString": "A can of diet soda."
},
"doUse":
{
"programBoolean": true
},
"isUseable":
{
"literalBoolean": true
},
"isPickupable":
{
"literalBoolean": true
},
"lua": "function doUse()\r\n\t-- NOTE: The engine actually has support for food objects that will adjust\r\n\t-- the player's weight appropriately, however, this is not yet exposed to\r\n\t-- LUA modding as of Feb 2018. For the purposes of this example, the soda\r\n\t-- will just replenish HP with no other consequences.\r\n\r\n\tplayer = Player.getInstance();\r\n\r\n\tMainScreen.addGameText('You gulp down the soda. ');\t\r\n\r\n\tplayer.heal(3); -- Heal 3HP\r\n\r\n\tthis.deleteEntity(); -- Remove entity from world or inventory\r\n\r\n\treturn true; -- Automatic continue scene\r\nend"
}
}
]
}

</syntaxhighlight>

Modding:Player

2026-02-27T08:57:54Z

SkyCorp: added optional parameter to dropItem

== Static Methods ==

=== static Player getInstance() ===
Get the instance of the Player class.
== Public Methods ==

=== 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

=== void deleteItem([[Entity]] entityToDelete) ===
Deletes a held item.

=== string getName() ===
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) ===
Is entityToCheck in player's inventory currently?

=== 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

=== void setLocation([[Location]] location) ===
Sets players new location. Note that no transition is displayed to player, nor does this (currently) fire any room transition events to inform entities that the player just entered this location.

(Added in r26)

=== 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.

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

=== 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, [bool removeTattoosAndPiercings]) ===
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) ===
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, bool silentTest=false) ===
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

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) ===
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(bool silent=false) ===
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) ===
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, bool silent=false) ===
Increases player lust by amount

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

=== 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 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.

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 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.

Intended for use with weight TF, pregnancy TF should use pregnancy functions!

=== 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.

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 ===
''(introduced in r35)''

Increases size of player's belly, outputs appropriate description text (due to pregnancy). Outputs one line of text, no newlines.

Does not actually cause player to become pregnant if they are not already.

=== setBellyPreg ===
''(introduced in r35)''

Sets belly size. One line text description of the TF, no newlines.

Does not actually cause player to become pregnant if they are not already.

=== int getBellyTotalWeight() ===
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() ===
A few word description of the player's belly (includes both preg & weight factors)

ex: "20 lb noticeably bulging belly"

=== int 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 height by number of inches

Returns true if any TF took place

=== boolean tfHeightShorter(int amount) ===
Decrease height by number of inches

Returns true if any TF took place

=== boolean tfHeightTowards(int targetHeightInches) ===
Shortcut function to move player's height towards a desired height

Returns true if any TF took place

=== void incMilkProduction(number amount) ===
Increases milk production, as long as player is not at max

Will do nothing if player has neither breasts nor udder

Will output text to player describing increase (no newline)

=== void decMilkProduction(number amount) ===
Decreases milk production

Will do nothing if player has neither breasts nor udder

Will output text to player describing decrease (no newline)

=== number getMilkProduction() ===
Amount of milk to produce every tick(0~20). More than 10 is considered overdrive.

=== string getUdderDescription() ===
Descriptive text of udder (indicates size)

Ex: "large basketball-sized udder"

=== number getUdderMilk() ===
0 = no udder, 1 = no milk <-> 100 = totally full of milk

=== boolean hasUdder() ===
Does player have an udder?

=== void createUdder() ===
If player does not already have an udder, create one for them along with a small basic amount of milk production. Output relevant text.

=== void removeUdder() ===
Removes udder from player along with a note.

=== void resetMilkSilent() ===
If lactating, reset ALL milk so player doesn't immediately have to give milk. It will re-fill over time if player has milk production. This is called after losing a fight, etc).

=== void resetBreastMilkSilent() ===
If lactating, reset milk so player doesn't immediately have to give milk (breast). It will re-fill over time if player has milk production.

=== void resetUdderMilkSilent() ===
If lactating, reset milk so player doesn't immediately have to give milk (udder). It will re-fill over time if player has milk production.

=== number getBreastMilk() ===
0 or 1 = no milk <-> 100 = totally full of milk

=== boolean isAbleToExercise() ===
Player can exercise once per day (too much is tiring)

=== boolean attemptExercise(int decreaseOverweightBy) ===
If player has not yet exercised today, they can attempt an exercise activity.

=== void resetExercise() ===
Call after rest to allow for exercising

=== boolean isAbleToWatchTV() ===
TVs and similar activities can be useful to help player reduce acceptance. Player can watch TV once per day.

=== void setIsAbleToWatchTV(boolean isAbletoWatchTV) ===
TVs and similar activities can be useful to help player reduce acceptance. Player can watch TV once per day.

=== void setBreastRows(int breastRows) ===
Immediately change # of breast rows without outputing additional text. 1 is normal for both male & female

=== boolean tfIncBreastRows() ===
Add a row of breasts and output appropriate descriptive text (does not include linebreak)

=== boolean tfDecBreastRows() ===
Remove a row of breasts and output appropriate descriptive text (does not include linebreak)

=== boolean getInHeat() ===
Returns true if player is a species type which can go into heat and they are currently in heat.

=== boolean getIsAllFours() ===
Is player moving around on all fours/eights (horizontal walking instead of upright/standing walk)?

Generally this is due to the leg joints of the player changing

=== void triggerInseminationChance() ===
Should be called whenever the player receives sperm vaginally. Depending on player's fertility / species, they may get knocked up from this call.

=== boolean getWristsBound() ===
Are the players wrists bound? This will limit options such as pick-up, drop, and masturbate.

=== boolean hasAlternateVoice() ===
With a non-human voice, players will have difficulty communicating with humans.

This indicates a voice that is so distorted, that it is impossible to understand (not just vocal modifiers)

=== string getAlternateVocal() ===
If the player has a non-human voice, what kind of noise do they make when trying to communicate?

=== void setHeightSilent(int height) ===
Sets new player height, in inches. No text output to screen, and does not perform normal bounds checking.

=== boolean hasClothing(string slot) ===
''(Introduced in r25)''

Is player wearing anything in that clothing slot?

=== [[Clothing]] getClothing(string slot) ===
''(Introduced in r25)''

Get what player wearing anything in that [[clothing slot]]. May be null

=== void resetPregnancySilent() ===
(Introduced in r35)

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.)

=== [[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 ==
[[Dick Size Increaser]]
[[Category:LUA Class Reference]]

Modding:Entity

2026-02-27T08:53:16Z

SkyCorp: Added setEntityName / setPersonalName

== Static Public Methods ==

=== static Entity generate(string entityName) ===
Generate a new entity of the given type based on the [[Types of Entities|entity type string]]. Null if unknown entity.

== Public Methods ==

=== string getName() ===
Gets name of entity

=== string getLookDesc() ===
Gets look description(the text displayed when looking at item)

=== boolean isExaminable() ===
Allow player to examine object? If so, the item is shown in the room item list. Otherwise, the object is invisible

=== boolean isAttackable() ===
Is player allowed to (attempt) to do an attack on this object -- shown when looking at object

=== boolean isUseable() ===
Is player shown a use button on this object -- shown when looking at object

=== boolean isPickupable() ===
Should object display a pick-up option if not yet in inventory? May or may not *actually* be pickupable. To do / attempt to do a pickup, use the [[Player]] class.

=== boolean isDropable() ===
Should object display a drop item button if is in inventory? May or may not *actually* be dropable. Use [[Player]] class to make the actual attempt.

=== void deleteEntity() ===
Removes entity from either the inventory or room that it exists in.

=== boolean isPlayerHere() ===
If entity is in world, is the player in this same room?

=== int isPlayerAdjacent() ===
If entity is in the world, is the player in a room adjacent to the one entity is in? If so, which room ID?

If not, room ID is 0. If player is in the same room, then room ID 0 is also returned.

=== [[Location]] getLocation() ===
Gets location of this entity. Returns null if entity is in inventory, or otherwise not in world.

=== void moveEntity(string newMapName:String, int newRoomID) ===
Moves entity from whereever it is (including inventory) into a particular location. If picking up the item, should use the functions on the Player class instead.

=== void moveEntityAdjacent([[Modding:CardinalDirection|CardinalDirection]] cardinalDirection, bool quiet = false) ===
Moves the entity to the adjacent room.Moves entity to new location.

If quiet is false, then it will announce the move to player if they are in entering or leaving room.

Exposed in r56.1

=== void moveEntityToSameRoomAsPlayer() ===
Move entity from wherever it is (including inventory) into the same room as the player is in.

=== void makeCursed() ===
Marks this entity as cursed. In order for this to have any effect, you should write a custom function for playerAttemptDropCheck.

Generally this would be called on start-up. Curse status can be modified by NPCs that can perform purification.

See [[Weight Pendant]] for an example of cursed items.

=== boolean getCursed() ===
Is this entity cursed?

=== [[Modding:BodyDescription|BodyDescription]] getBodyDescription() ===
Gets body description for this npc -- may be nil if no body description has been set.

Added in r56.1

== Private Methods ==

=== void setEntityName(string name) ===
Sets name of entity, assuming it hasn't otherwise been overridden. (This is equivalent to changing the 'initialName' parameter)

=== void setPersonalName(string name) ===
Sets personal name of entity (typically only used for NPCs, it is the name that the entity refers to itself as, without any honorifics, and the UI might refer to after the player becomes familiar with it enough)

=== setBodyDescription([[Modding:BodyDescription|BodyDescription]] bodyDescription) ===
Sets/overwrites body description for this npc.

Added in r56.1

=== Default versions of functions ===
These are useful for calling if you want to do some logic first, and then fall back to the usual monster logic.

==== string defaultGetName([[Modding:NameType|NameType]] nameType = NameType.Unspecified) ====
As of r56.1, this is mostly useful to advanced monster mods, but is available to all entities. (Entities currently have no way to set the initial name value, so calling the default get name will just return "uninitialized entity". It is useful for advanced monster mods since they can set the name via 'initialValues' and thus access when UI name is supposed to be sleeping, etc.)

==== void defaultAddEntityLookOptions([[Modding:DynamicOptions|DynamicOptions]] dynamicOptions, [[Modding:Scene|Scene]] returnScene) ====
Adds commonly needed option to the passed dynamicOptions object for the entity look scene (pick-up, back button, attack, etc.)
[[Category:LUA Class Reference]]

Modding:Bundles

2026-02-25T06:08:59Z

SkyCorp: Tip on how to do empty bundles

Bundles are mods that contain multiple mod types within them. (Introduced in r56.1)

== Methods of bundling ==
There are two ways to create bundles:

1) Manually through JSON (forced)

2) Automatically through the mod dependencies system

Generally speaking, manual bundles should only be made if the submods have ''no'' potential use independently. For instance, before bundling a monster and a map manually, consider that another modder might want to use the monster in a custom map, or spawn it in a procedural map. In that case, having each of the monster and the map individually listed in the mod database allows more flexibility for the mods to be used in future ways.

== Mod dependencies bundling (Automatic) ==
This is the easiest and most flexible way of bundling -- each mod can list its own dependencies in the mod portal. Then when the user installs the mod, all dependencies will be installed recursively.

=== Tip: Empty bundles ===
If a mod ''only'' has dependencies but no content itself, it is possible to set the mod json as <code>{ }</code> You can then set the dependencies as desired.

This may be useful if you are building a related set of mods but they function independently and wouldn't normally need to depend on each other, but you still want a cohesive way for people to download the entire set together with one download.

== Manual bundling ==
Set the type of the mod to <code>BUNDLE</code>.

=== Syntax ===
<syntaxhighlight lang="json">
{
"type": "BUNDLE",
"includedMods":
[
{
"spawn": true,
"mod":
{ ... }
},
{
"spawn": true,
"mod":
{ ... }
}, ...
]
}
</syntaxhighlight>

=== Parameters ===
<code>includedMods</code> will be an array of sub mods, each one specifies:

* <code>spawn</code> - whether the item or monster should be spawned in the environment
* <code>mod</code> - the submod's json

=== Full example ===
This example bundles the [https://skycorp.global/skyscript/mods/v/20/sample-vending-machine vending machine] and the [https://skycorp.global/skyscript/mods/v/19/sample-soda soda] it dispenses as one combined mod. It only spawns the vending machine, but since the soda is loaded, the vending machine can spawn soda through its lua code.

(In reality, you would not want to bundle these together as by using the automatic dependency system, other mods could make use of the soda entity for their own purposes.)<syntaxhighlight lang="json">
{
"type": "BUNDLE",
"includedMods":
[
{
"spawn": true,
"mod":
{
"type": "ENTITY",
"name":
{
"literalString": "Vending Machine"
},
"description":
{
"literalString": "The vending machine advertises $1 for one diet soda."
},
"doUse":
{
"programBoolean": true
},
"isUseable":
{
"literalBoolean": true
},
"lua": "function doUse()\r\n\t-- NOTE: If creating a full store, it would probably be better to use the\r\n\t-- existing store code, however as of Feb 2018 this is not yet exposed to\r\n\t-- LUA modding. However, this is fine for a 'shop' that only sells one\r\n\t-- item.\r\n\r\n\tplayer = Player.getInstance();\r\n\r\n\tif player.removeCash(1) then\r\n\t\t-- Player has enough currency to cover the transaction, and it was\r\n\t\t-- deducted successfully.\r\n\r\n\t\t-- This matches the id field in entity json. Generally best to use the\r\n\t\t-- same name as your mod wiki page to prevent conflicts between multiple\r\n\t\t-- mods.\r\n\t\tsoda = Entity.generate(\"Sample Soda\");\r\n\r\n\t\tif soda == nil then\r\n\t\t\tMainScreen.addGameText(\"Please also load the Sample Soda mod.\");\r\n\t\telse\r\n\t\t\tMainScreen.addGameText('You insert $1 into the vending machine. ' ..\r\n\t\t\t\t'It spits out a can of diet soda.');\r\n\r\n\t\t\t-- Set location to be the same location as vending machine.\r\n\t\t\t-- Since the player must be next to the vending machine to use it,\r\n\t\t\t-- this function works fine. Another (longer) method would be to get\r\n\t\t\t-- the vending machine's location and set the soda's location to it.\t\t\t\r\n\t\t\tsoda.moveEntityToSameRoomAsPlayer();\r\n\t\tend\r\n\telse\r\n\t\t-- Player didn't have enough currency to cover the total cost of transaction.\r\n\t\t-- No currency was deducted.\r\n\t\t\r\n\t\tMainScreen.addGameText('You need at least $1 to buy a soda.');\t\r\n\tend\r\n\r\n\treturn true; -- Automatic continue scene\r\nend"
}
},
{
"spawn": false,
"mod":
{
"type": "ENTITY",
"id": "Sample Soda",
"name":
{
"literalString": "Soda"
},
"description":
{
"literalString": "A can of diet soda."
},
"doUse":
{
"programBoolean": true
},
"isUseable":
{
"literalBoolean": true
},
"isPickupable":
{
"literalBoolean": true
},
"lua": "function doUse()\r\n\t-- NOTE: The engine actually has support for food objects that will adjust\r\n\t-- the player's weight appropriately, however, this is not yet exposed to\r\n\t-- LUA modding as of Feb 2018. For the purposes of this example, the soda\r\n\t-- will just replenish HP with no other consequences.\r\n\r\n\tplayer = Player.getInstance();\r\n\r\n\tMainScreen.addGameText('You gulp down the soda. ');\t\r\n\r\n\tplayer.heal(3); -- Heal 3HP\r\n\r\n\tthis.deleteEntity(); -- Remove entity from world or inventory\r\n\r\n\treturn true; -- Automatic continue scene\r\nend"
}
}
]
}

</syntaxhighlight>

Modding:Player

2026-02-25T03:12:24Z

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

== Static Methods ==

=== static Player getInstance() ===
Get the instance of the Player class.
== Public Methods ==

=== 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

=== void deleteItem([[Entity]] entityToDelete) ===
Deletes a held item.

=== string getName() ===
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) ===
Is entityToCheck in player's inventory currently?

=== 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

=== void setLocation([[Location]] location) ===
Sets players new location. Note that no transition is displayed to player, nor does this (currently) fire any room transition events to inform entities that the player just entered this location.

(Added in r26)

=== 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.

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

=== 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, [bool removeTattoosAndPiercings]) ===
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) ===
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(bool silent=false) ===
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) ===
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, bool silent=false) ===
Increases player lust by amount

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

=== 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 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.

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 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.

Intended for use with weight TF, pregnancy TF should use pregnancy functions!

=== 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.

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 ===
''(introduced in r35)''

Increases size of player's belly, outputs appropriate description text (due to pregnancy). Outputs one line of text, no newlines.

Does not actually cause player to become pregnant if they are not already.

=== setBellyPreg ===
''(introduced in r35)''

Sets belly size. One line text description of the TF, no newlines.

Does not actually cause player to become pregnant if they are not already.

=== int getBellyTotalWeight() ===
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() ===
A few word description of the player's belly (includes both preg & weight factors)

ex: "20 lb noticeably bulging belly"

=== int 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 height by number of inches

Returns true if any TF took place

=== boolean tfHeightShorter(int amount) ===
Decrease height by number of inches

Returns true if any TF took place

=== boolean tfHeightTowards(int targetHeightInches) ===
Shortcut function to move player's height towards a desired height

Returns true if any TF took place

=== void incMilkProduction(number amount) ===
Increases milk production, as long as player is not at max

Will do nothing if player has neither breasts nor udder

Will output text to player describing increase (no newline)

=== void decMilkProduction(number amount) ===
Decreases milk production

Will do nothing if player has neither breasts nor udder

Will output text to player describing decrease (no newline)

=== number getMilkProduction() ===
Amount of milk to produce every tick(0~20). More than 10 is considered overdrive.

=== string getUdderDescription() ===
Descriptive text of udder (indicates size)

Ex: "large basketball-sized udder"

=== number getUdderMilk() ===
0 = no udder, 1 = no milk <-> 100 = totally full of milk

=== boolean hasUdder() ===
Does player have an udder?

=== void createUdder() ===
If player does not already have an udder, create one for them along with a small basic amount of milk production. Output relevant text.

=== void removeUdder() ===
Removes udder from player along with a note.

=== void resetMilkSilent() ===
If lactating, reset ALL milk so player doesn't immediately have to give milk. It will re-fill over time if player has milk production. This is called after losing a fight, etc).

=== void resetBreastMilkSilent() ===
If lactating, reset milk so player doesn't immediately have to give milk (breast). It will re-fill over time if player has milk production.

=== void resetUdderMilkSilent() ===
If lactating, reset milk so player doesn't immediately have to give milk (udder). It will re-fill over time if player has milk production.

=== number getBreastMilk() ===
0 or 1 = no milk <-> 100 = totally full of milk

=== boolean isAbleToExercise() ===
Player can exercise once per day (too much is tiring)

=== boolean attemptExercise(int decreaseOverweightBy) ===
If player has not yet exercised today, they can attempt an exercise activity.

=== void resetExercise() ===
Call after rest to allow for exercising

=== boolean isAbleToWatchTV() ===
TVs and similar activities can be useful to help player reduce acceptance. Player can watch TV once per day.

=== void setIsAbleToWatchTV(boolean isAbletoWatchTV) ===
TVs and similar activities can be useful to help player reduce acceptance. Player can watch TV once per day.

=== void setBreastRows(int breastRows) ===
Immediately change # of breast rows without outputing additional text. 1 is normal for both male & female

=== boolean tfIncBreastRows() ===
Add a row of breasts and output appropriate descriptive text (does not include linebreak)

=== boolean tfDecBreastRows() ===
Remove a row of breasts and output appropriate descriptive text (does not include linebreak)

=== boolean getInHeat() ===
Returns true if player is a species type which can go into heat and they are currently in heat.

=== boolean getIsAllFours() ===
Is player moving around on all fours/eights (horizontal walking instead of upright/standing walk)?

Generally this is due to the leg joints of the player changing

=== void triggerInseminationChance() ===
Should be called whenever the player receives sperm vaginally. Depending on player's fertility / species, they may get knocked up from this call.

=== boolean getWristsBound() ===
Are the players wrists bound? This will limit options such as pick-up, drop, and masturbate.

=== boolean hasAlternateVoice() ===
With a non-human voice, players will have difficulty communicating with humans.

This indicates a voice that is so distorted, that it is impossible to understand (not just vocal modifiers)

=== string getAlternateVocal() ===
If the player has a non-human voice, what kind of noise do they make when trying to communicate?

=== void setHeightSilent(int height) ===
Sets new player height, in inches. No text output to screen, and does not perform normal bounds checking.

=== boolean hasClothing(string slot) ===
''(Introduced in r25)''

Is player wearing anything in that clothing slot?

=== [[Clothing]] getClothing(string slot) ===
''(Introduced in r25)''

Get what player wearing anything in that [[clothing slot]]. May be null

=== void resetPregnancySilent() ===
(Introduced in r35)

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.)

=== [[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 ==
[[Dick Size Increaser]]
[[Category:LUA Class Reference]]

Modding:Defining Names

2026-02-25T01:52:55Z

SkyCorp: Document how to use initial values name for entity mods

This page will detail some general information about how names are defined for mods.

Most situations will fit into one of the following patterns:

== Simple Monster Mod - Static Name ==
A simple monster mod (no code) who always has the same name can do something like this:<syntaxhighlight lang="json">
{
...,
"name": "Harpy"
},
...
}
</syntaxhighlight>See [https://skycorp.global/skyscript/mods/v/6/male-spider Spider] or [https://sclab.skycorp.global/ SCLab] for examples.

== Entities - Static Name ==
Physical objects (ex: a painting) probably just need a single name, in which case they will not define a dynamic function and just use use the 'literalString' functionality. <syntaxhighlight lang="json">
{
...,
"name":
{
"literalString": "Fox Painting"
},
...
}
</syntaxhighlight>Example: [https://skycorp.global/skyscript/mods/v/27/sample-radio Radio]

== Entities - Static Name ==
A second option for setting names is to use the initial name field: <syntaxhighlight lang="json">
{
...,
"initialValues":
{
"name": "Fox Painting",
...
},
...
}
</syntaxhighlight>

The initial name will set the object's initial name, but let other functions modify it. This is ideal if the entity will later on end up owning the player or might otherwise have a name change during gameplay. Basically, consider this a softer version of setting a name that tries to respect existing game logic, whereas the name function override described above is a harder version which will override other game functionality.

== Advanced Monsters - Static Name ==
Most monsters don't change names. In this case, it is fine to use the 'initialValues' to set their base name. This has the advantage that when the UI name changes, the existing logic will handle this because name is not being overridden. For instance, when the monster sleeps, or becomes your owner. Example:<syntaxhighlight lang="json">
{
...,
"initialValues":
{
"name": "Wyvern",
...
},
...
}
</syntaxhighlight>Example: [https://skycorp.global/skyscript/mods/v/45/wyvern-shemale Wyvern Shemale]

== Advanced Monsters - Personal Name ==
You may want to have a monster appear to be generic at first, but use a [[Entity Mod JSON Format#personalName()|personal name]] once they become the player's owner or in gametext. In this case, you can use the personal name feature:<syntaxhighlight lang="json">
{
...,
"initialValues":
{
"name": "Fox",
...
},
"personalName": {
"literalString": "Tina"
},
"pronoun": {
"literalString": "she"
},
}
</syntaxhighlight>

== Advanced Monsters - Random Name ==
You may want to have many monsters of a specific type (ex: Fox), but each of those monsters have their own individual random name (ex: Veronica, Amy, etc). In this case, you can use the random name feature:<syntaxhighlight lang="json">
{
...,
"initialValues":
{
"name": "Fox",
...
},
"usesRandomizedName": {
"literalBoolean": true
},
"pronoun": {
"literalString": "she"
},
}
</syntaxhighlight>[[Entity Mod JSON Format#pronoun()|Pronoun]] is also set so that the correct name gender will be pulled from the random list.

Example: SetOwnerWithScene

== Custom (Entity or Adv. Monster) ==
You can also completely override how name is shown and displayed by implementing <code>name([[Modding:NameType|nameType]])</code><syntaxhighlight lang="lua">
function name(nameType)
if nameType == NameType.UI then
return "Blep-Button";
end

if nameType == NameType.GameText then
return "Blep-Personal";
end

return "Blep-General";
-- For testing purposes only. In a real situation, the
-- UI and Unspecified types should usually be the same thing.
-- Ex: UI&Unspecified is "Fox" and GameText is "Veronica"
end
</syntaxhighlight>More practically, for advanced monsters, you could also set the name normally, and when needed, override it in certain circumstances, ex:<syntaxhighlight lang="lua">
function name(nameType)
if blepping == true then
return "Blepper";
end

return this.defaultGetName(nameType);
end
</syntaxhighlight>Most mods won't need to override the name function like this though to accomplish normal game behavior.

Entity Mod JSON Format

2026-02-25T01:47:43Z

SkyCorp: Added new fixed field option for entity mods: name/initialValues

Entity JSON supports a variety of parameters to create custom objects.

== Fixed fields ==
A "'''type'''" of "ENTITY" should be used when creating an entity mod.

An optional "'''id'''" parameter can be used to refer to this type of entity (for instance in Entity.generate() to programmatically create additional entities). Be careful not to use the same id as another mod -- if you use the same mod name as your mod wiki page, you can be assured of no conflicts. (Introduced in r25)

An optional "'''customPublicFunctions'''" parameter is an array of custom lua functions that should be publicly available to other lua scripts. The [[Sample: Radio|radio sample]] shows an example of this. You can pass and return values, however, it's recommened to stick with primitive values when possible. Initial testing shows complex values like Tables and Entities are also okay to pass, but this is not well tested yet. (Introduced in r35)

=== initialValues ===
Collection of values that may be changed or overwritten later:

* name (added r56.1; See also: [[Modding:Defining Names|Defining Names]])

== Dynamic fields ==
JSON definitions can specify each as programmable (LUA) or literal values.
{| class="wikitable"
!Return Type
!Parameter
|-
|string
|
=== name([[Modding:NameType|NameType]] nameType = NameType.Unspecified) ===
Title of the item.

A nametype may be parsed to differentiate which type of name is being requested (ex: a button name or dialogue name)

See also: [[Modding:Defining Names|Defining Names]]
|-
|string
|
=== description ===
Description of the item when looked at.
|-
|boolean
|
=== playerOnEnterRoom ===
Can be used to present some special text when player enters a room when this object is inside it or prevent the player from entering. But if it's not necessary to prevent player from entering, you may want to use the notify version of this function below.

Normally true. If false, will prevent mapscene from doing further room processing (be sure to use a continue scene)

As of r35, Lua function will receive these variables as parameters:

- currentRoom:String (however, currentRoom is placeholder. It can be queried for manually if needed based on entity current position)

- destinationRoom:String
|-
|boolean
|
=== playerAttemptLeaveRoom ===
Can be used to prevent player from leaving room when in same room as entity.

Normally true. If false, will prevent mapscene from doing further room processing (be sure to use a continue scene)

As of r35, Lua function will receive these variables as parameters:

- currentRoom:String (however, currentRoom is placeholder. It can be queried for manually if needed based on entity current position)

- destinationRoom:String

- destinationRoomID:int

(In r51, the internal way playerAttemptLeaveRoom() works changed to use Locations, however, the modding system has not yet been updated. If you need to use currentRoom or get map information, ask Skye to update this mod API for this function to use Locations also.)
|-
|boolean
|
=== isExaminable ===
Allow player to examine object? (This is the page description is displayed on. Otherwise will be invisible to player).
|-
|boolean
|
=== isUseable ===
Display the 'use' button on the examine item page?
|-
|void
|
=== addEntityLookOptions([[Modding:DynamicOptions|DynamicOptions]] dynamicOptions, [[Modding:Scene|Scene]] returnScene) ===
Provides a mechanism to add additional buttons (or completely change the buttons) on the entity look scene -- which is the scene shown when you examine an item or npc.

Usually you would want to call <code>this.defaultAddEntityLookOptions(dynamicOptions, returnScene);</code> to also include the normal buttons (pick up, back, etc).
* The return scene is the scene that is intended for the user to return to on pressing 'back' (usually map scene).
* dynamicOptions can be modified via its function call to add new options.

Sample: [https://skycorp.global/skyscript/mods/v/92/sample-entity-with-extra-look-buttons Entity with extra look options]

Added in r56.1
|-
|boolean
|

=== doUse ===
Action to do on using entity.

Usually should return true -- this will cause a continue scene after the text.

For a manual continue or a different scene change, return false.
|-
|boolean
|
=== isPickupable ===
Should a pick-up item be displayed on item page if item is in the world?
|-
|boolean
|
=== playerAttemptPickupCheck ===
Player has opted to pick up the item (may output descriptive message to screen)

Returns if successful in pickup attempt.
|-
|boolean
|
=== isDropable ===
Should a drop item be displayed on item page if item is in inventory?
|-
|boolean
|
=== playerAttemptDropCheck ===
Player has opted to drop the item. Return if successful in drop attempt.
|-
|void
|
=== inInventoryTick ===
Called each turn the item exists in the player's inventory.
|-
|void
|
===inWorldTick===
Called each turn the item exists on the map somewhere (may not be called if player is on a different map).
|-
|void
|
===notifyPlayerEnterRoom===
Notify object that player has just entered the same room as us.

Okay to output to screen - this is called after showScene() of the room.

As of r35, Lua function will receive these variables as parameters:

- arrivingFromRoom String name of room that was arrived from (before this room)

- arrivingFromRoomID ID of room arriving from (before this room)
|-
|void
|
===notifyPlayerEnterRoomPreScene===
Notify object that player has just entered the same room as us

This variant happens BEFORE showScene() is called, so is best for when entities are moving in/out based on player actions.

Don't output to screen using this call - it will be eaten by showScene()

As of r35, Lua function will receive these variables as parameters:

- arrivingFromRoom String name of room that was arrived from (before this room)

- arrivingFromRoomID ID of room arriving from (before this room)

|-
|void
|
===notifyPlayerLeftRoom===
Notify entity of the room the player is leaving that the player left successfully. Entities should not write to the screen since showScene() will immediately overwrite it.

The player's position has already been updated with the correct location by this point.

As of r35, Lua function will receive these variables as parameters:

- originalRoomName

- originalRoomID
|-
|string
|
===personalName()===
A name of them as a person (eg: 'Micky') as opposed to the general name above. This name would be used as the character refers to themselves. Ie, 'I am Micky' as opposed to 'I am Cowgirl Micky'. If you set this, normally the name field would be something more generic, like their species.

Normally when you first encounter an enemy, it just shows their generic type (ex: "AlphaSlug") as their button (UI Name), which is what the main name field is. Their dialogue might use their name (the "GameText" name, which pulls from this personalName field), and if they become your owner, their UI name likely becomes something like "<Honorific> <Personal Name>"

Note, if you set this (or usesRandomizedName() below), it is recommended to not set the overall name function. To set species/initial UI name, you can set the 'name' field in 'initialValues' instead of the 'name' function override.

See also: [[Modding:Defining Names|Defining Names]]

Introduced in r56.1
|-
|bool
|
===usesRandomizedName()===
If true, a randomized name will be assigned to this entity. The name will be a common one related to the assigned pronouns of the entity. (Mostly makes sense for NPCs)

Introduced in r56.1
|-
|string
|
===desiredPlayerSubmissiveType()===
Can define this if the npc is a dom to tell game text what sorts of sub types to use for its variables. Basically, what sort of dom/sub relationship will the npc form with the player, if the player accepts them as their owner?

Currently, the following sub types are supported:
*Sub (Default)
*Breeder
*Pet
*Slave

Any other string other than the above is currently not supported.

Introduced in r56.1
|-
|string
|
===pronoun()===
If an NPC, can set this to the character's pronouns so gametext variables can refer to them properly.

Currently, the following pronoun types are supported:
*Unspecified (default)
*He
*She
*Shi
*It
*They

Any other string other than the above is currently not supported.

Introduced in r56.1
|}

Modding:MapScene

2026-02-23T20:16:10Z

SkyCorp: MapScene now available to modders

Map Scene is the view of the game that is seen when moving from room to room. Currently, it also houses a number of movement and action related logic functions that are not map specific (for those see the [[Modding:Map|Map]] class).

==Static Methods==

===static MapScene getInstance()===
Get the instance of the MapScene class.
==Public Methods==

===void setCurrentRoomID(string mapName, int newRoom)===
Sets room player is currently in. No text / transition is shown to player, this is essentially an 'instant' warp with no further logic checks performed.

=== void teleportToRespawn() ===
Teleport player to a good respawn position (generally after they have died). The exact location is dependent on the player's form and other restrictions (map-specific respawn logic will be respected, if available).

=== bool teleportToMapSpecificRespawnIfAny() ===
Not typically called -- usually you would call teleportToRespawn() instead as there are also fallbacks to teleport the player to other locations. However, if you want to ''only'' use map specific logic, and otherwise not move the player, this function is good.

=== bool isInPublicOverworldRoom() ===
Checks if room player is currently in is in view of public (ex: public parts of Mulberry township, near guard outposts, etc)

=== void tickGame() ===
Essentially this performs one 'turn' of the game world -- all subsystem calculations will be called and player/monster states updated, etc. This will give monster a chance to attack the player, etc.

=== bool getInCombatCurrently() ===
Is player in combat currently (is there another mob in this room in ATTACK mode?

=== void readyForNextTurn() ===
This function 'resets' the map scene, such that the next time the map scene is shown, it will count as a new turn. If the player spent a long time in a submenu (ex: made an action that would take a notable amount of time, then it makes sense the world should update in the intervening time. This will give monster a chance to attack the player, etc. when the map scene is shown again.

=== [[Modding:Entity|Entity]] getPlayerAttacker() ===
Find a monster that is currently attacking the player (must be in same room). Nil if none.

[[Category:LUA Class Reference]]

Modding:Species

2026-02-19T21:06:27Z

SkyCorp: Oops, wrong return type in the documentation for getSpecies()

== Public Static Methods ==

=== static Species getSpecies(string speciesName) ===
Gets species object from species name (ID string). Returns null if species with that name can not be found.

== Public Methods ==

=== string getID() ===
Gets species name (ID) of this TF

=== void causeTF() ===
Causes one step of this transformation to be applied to the player. Text will be output to screen.

=== int countPlayerPartsOfThisType() ===
Returns the number of body parts transformed into this species type

=== int getSeverityTFed([[BodyPart]] bodyPart) ===
Gets how severly the player is transformed to THIS type of species for this body part.

IE, a fox tf would return 0 if the player is a level 0 human, or a level 1 cat, because they're not at all fox tf'ed.

=== bool getIsFullyTransformed() ===
If player is as transformed into this species as they possibly can be. If not, causeTF() should cause the player to be TF'ed further.

=== string getBodyPartDescription([[BodyPart]] bodyPart, int severity) ===
Get a text description for what a body part at a given severity of transformation looks like.

Note that it is usually just easier to use text parsing variables if you're describing the player at their current state.

=== bool hasAlternateVoice() ===
With a non-human voice, players will have difficulty communicating with humans. (False for normal english speech)

=== string getAlternateVocal() ===
If the player has a non-human voice, what kind of noise do they make when trying to communicate?

=== bool tfBreast() ===
Increases player's breast size up to the ''minimumTargetBreastSize'' property. Returns true if any TF was performed.

=== bool tfNoPenisOneVagina() ===
Will TF player towards having one vagina and no penis (shrink dick then grow vagina). Will also cause breast growth if ''minimumTargetBreastSize'' is set (it calls tfBreast()).

If there is a reason player must have a penis, then don't affect penis but still grow vagina. For instance, a male player wearing a cursed cock ring will result in a futa character.

Returns true if any TF was performed.

=== bool shouldAttemptTransformation() ===
Checks if any changes likely to be available. Checking this prior to calling causeTF() or a forced TF sequence helps avoid going into a TF scene with no TF. Does NOT guarantee causeTF() will actually do a TF!

(added in r54)

=== bool CheckSpeciesTransformationAllowed(bool silent=false) ===
Convenience function for checking if species-level transformation is permitted. Outputs to screen if blocked and silent is not set.

(added in r54)

=== bool checkBodyPartTransformationAllowed([[BodyPart]] bodyPart, bool silent=true) ===
Convenience function for checking if particular body part transformation is permitted. Outputs to screen if blocked and silent is not set.

Unlike the species version of this check, silent is default for this. That is because usually we don't want to output text for each body part as that would be confusing/spammy to player why the same body parts keep getting attempted.

(added in r54)

=== void onTransformed() ===
Intended to be called after every successful transformation, allowing other systems opportunity to react to a species transformation. Custom species should call this so if the game is in permanent TF mode and no permanent species has been set yet, the player can be locked to this species.

(added in r54)

== Public Variables ==

=== [get only] bool feminize ===
If set, this variable will cause a player to also change gender. Feminization will cause player to grow breasts to a size appropriate for the species (see private variable minimumTargetBreastSize), and genital change (unless wearing a shemale item like cock ring).

This setting gets turned on when:

* Player has enabled the Always Feminize game mode option during character creation.
* A TF can also be created as a Feminize variant when it is initialized, though this is rare.

It's expected that a custom causeTF() will either:

* Check this feminize setting and feminize if set (for species like vanilla dragon that don't automatically imply gender TF)
* Or ignore the feminization setting entirely and force gender TF regardless (for species that always feminize, ex: dragon queen, titslug, etc.)

(added in r54)

== Private Methods ==

=== bool checkFullyFeminizedIfShould(int targetBreastSize, int targetVaginaSize=1, bool thisTfAlwaysFeminizes=false) ===
Helper function called by TFs to determine if this TF can potentially transform player gender more. Species don't always cause feminization, but they can if either the relevant game option is chosen during character creation, or its a transformation that implies gender tf (ex: mermaid).

targetVaginaSize: Most TG's just use the TfNoPenisOneVagina() function, which currently only TF's the player vagina one step. Unless a particular sized vagina is part of the TF, just call this without overloads.

thisTfAlwaysFeminizes: Set true if breast growth should ''always'' happen, and also if penis->vagina tf should happen (at least, if it doesn't conflict with player's persist dick setting (ex: cock ring)).

(added in r54)

== Private Variables ==

=== int minimumTargetBreastSize ===
How big player breasts should be due to this transformation. Repeated calls to tfBreast() or tfNoPenisOneVagina() will increase player's breast size to these. See [[Player#int getBreastSize.28.29|Player.GetBreastSize()]] for size reference.
 

[[Category:LUA Class Reference]]

Modding:Getting Started Modding

2026-02-05T21:22:30Z

SkyCorp: Link mod bundles page

Want to make a mod for The Underworld? Great!

== Tips on Learning ==
The best way to learn is to start gradually, making more complex mods as you go:
* It is best to start with making a Monster mod, as it is the simplest type of thing to make (an editor is provided).
* Afterwards, clothes and entities (items) introduce custom LUA scripting.
* Transformations (Species) are the most complex mod to create, but even people new to LUA scripting have managed it. However, it is much easier to start by learning to create a simple entity (item) first, then jump into transformations!
* Maps can be very simple or very complex depending on what kind of map you want to make.
Ask questions in the forums modding section!

== How To's ==
How to make...
* Monsters
** [[Creating a Monster Mod|Basic]] (includes simple editor, no code required!)
** [[Creating a MonsterAdvanced Mod|Advanced]] (LUA code supported)
* [[Creating an Entity Mod|Entities]]
* [[Creating a Clothing Mod|Clothes]]
* [[Creating a Transformation Mod|Transformations]]
* [[Creating a Map Mod|Maps]]
* [[Modding:Bundles|Bundles]]

Modding:Bundles

2026-02-05T21:21:46Z

SkyCorp: Mod bundles!

Bundles are mods that contain multiple mod types within them. (Introduced in r56.1)

== Methods of bundling ==
There are two ways to create bundles:

1) Manually through JSON (forced)

2) Automatically through the mod dependencies system

Generally speaking, manual bundles should only be made if the submods have ''no'' potential use independently. For instance, before bundling a monster and a map manually, consider that another modder might want to use the monster in a custom map, or spawn it in a procedural map. In that case, having each of the monster and the map individually listed in the mod database allows more flexibility for the mods to be used in future ways.

== Mod dependencies bundling (Automatic) ==
This is the easiest and most flexible way of bundling -- each mod can list its own dependencies in the mod portal. Then when the user installs the mod, all dependencies will be installed recursively.

== Manual bundling ==
Set the type of the mod to <code>BUNDLE</code>.

=== Syntax ===
<syntaxhighlight lang="json">
{
"type": "BUNDLE",
"includedMods":
[
{
"spawn": true,
"mod":
{ ... }
},
{
"spawn": true,
"mod":
{ ... }
}, ...
]
}
</syntaxhighlight>

=== Parameters ===
<code>includedMods</code> will be an array of sub mods, each one specifies:

* <code>spawn</code> - whether the item or monster should be spawned in the environment
* <code>mod</code> - the submod's json

=== Full example ===
This example bundles the [https://skycorp.global/skyscript/mods/v/20/sample-vending-machine vending machine] and the [https://skycorp.global/skyscript/mods/v/19/sample-soda soda] it dispenses as one combined mod. It only spawns the vending machine, but since the soda is loaded, the vending machine can spawn soda through its lua code.

(In reality, you would not want to bundle these together as by using the automatic dependency system, other mods could make use of the soda entity for their own purposes.)<syntaxhighlight lang="json">
{
"type": "BUNDLE",
"includedMods":
[
{
"spawn": true,
"mod":
{
"type": "ENTITY",
"name":
{
"literalString": "Vending Machine"
},
"description":
{
"literalString": "The vending machine advertises $1 for one diet soda."
},
"doUse":
{
"programBoolean": true
},
"isUseable":
{
"literalBoolean": true
},
"lua": "function doUse()\r\n\t-- NOTE: If creating a full store, it would probably be better to use the\r\n\t-- existing store code, however as of Feb 2018 this is not yet exposed to\r\n\t-- LUA modding. However, this is fine for a 'shop' that only sells one\r\n\t-- item.\r\n\r\n\tplayer = Player.getInstance();\r\n\r\n\tif player.removeCash(1) then\r\n\t\t-- Player has enough currency to cover the transaction, and it was\r\n\t\t-- deducted successfully.\r\n\r\n\t\t-- This matches the id field in entity json. Generally best to use the\r\n\t\t-- same name as your mod wiki page to prevent conflicts between multiple\r\n\t\t-- mods.\r\n\t\tsoda = Entity.generate(\"Sample Soda\");\r\n\r\n\t\tif soda == nil then\r\n\t\t\tMainScreen.addGameText(\"Please also load the Sample Soda mod.\");\r\n\t\telse\r\n\t\t\tMainScreen.addGameText('You insert $1 into the vending machine. ' ..\r\n\t\t\t\t'It spits out a can of diet soda.');\r\n\r\n\t\t\t-- Set location to be the same location as vending machine.\r\n\t\t\t-- Since the player must be next to the vending machine to use it,\r\n\t\t\t-- this function works fine. Another (longer) method would be to get\r\n\t\t\t-- the vending machine's location and set the soda's location to it.\t\t\t\r\n\t\t\tsoda.moveEntityToSameRoomAsPlayer();\r\n\t\tend\r\n\telse\r\n\t\t-- Player didn't have enough currency to cover the total cost of transaction.\r\n\t\t-- No currency was deducted.\r\n\t\t\r\n\t\tMainScreen.addGameText('You need at least $1 to buy a soda.');\t\r\n\tend\r\n\r\n\treturn true; -- Automatic continue scene\r\nend"
}
},
{
"spawn": false,
"mod":
{
"type": "ENTITY",
"id": "Sample Soda",
"name":
{
"literalString": "Soda"
},
"description":
{
"literalString": "A can of diet soda."
},
"doUse":
{
"programBoolean": true
},
"isUseable":
{
"literalBoolean": true
},
"isPickupable":
{
"literalBoolean": true
},
"lua": "function doUse()\r\n\t-- NOTE: The engine actually has support for food objects that will adjust\r\n\t-- the player's weight appropriately, however, this is not yet exposed to\r\n\t-- LUA modding as of Feb 2018. For the purposes of this example, the soda\r\n\t-- will just replenish HP with no other consequences.\r\n\r\n\tplayer = Player.getInstance();\r\n\r\n\tMainScreen.addGameText('You gulp down the soda. ');\t\r\n\r\n\tplayer.heal(3); -- Heal 3HP\r\n\r\n\tthis.deleteEntity(); -- Remove entity from world or inventory\r\n\r\n\treturn true; -- Automatic continue scene\r\nend"
}
}
]
}

</syntaxhighlight>

Modding:BodyDescription

2026-02-04T02:06:07Z

SkyCorp: Add sample code link

This class lets you describe an NPC's appearance. [[Modding:Text Variables|Text variables]] can then use this appearance data in scenes.

== Static Methods ==

=== static public BodyDescription generateNew() ===
Creates a new body description.

Note that it must be assigned to the NPC after you finish configuring it!

== Public Methods ==

=== void setBreastSize(int breastSize) ===
Size of breasts -- uses same scale used by player class

=== int getBreastSize() ===

=== void setBreastRows(int breastRows) ===
Number of rows of breasts

=== int getBreastRows() ===

=== void setDickSize(int dickSize) ===
Size of dick -- uses same scale as player class

=== int getDickSize() ===

=== void setVaginaSize(int vaginaSize) ===
Size of vagina -- uses same scale as player class

=== int getVaginaSize() ===

=== void setDexterous(bool dexterous) ===
Does the character have dexterous hands? False if no hands, hands are bound, or non-dexterous paws

=== bool isDexterous() ===

=== bool getHasAlternateVoice() ===
If the NPC is incapable of normal human speech (also see Vocal string below).

=== void setHasAlternateVoice(bool hasAlternateVoice) ===

=== string getAlternateVocalString() ===
If NPC is incapable of normal human speech (alternate vocal bool above), then what noise do they produce instead?

=== void setAlternateVocalString(string alternateVocalString) ===

=== bool getBipedal() ===
If the NPC walks on two legs

=== void setBipedal(bool bipedal) ===

=== void setUniqueBodyPartDescription(string bodyPartName, string description) ===
Can set a description for a body part for specific flavor.

=== string getBodyPartDescription(string bodyPartName) ===
Tries to get the body part description, if one is defined. If unavailable, just returns ""

== Sample code ==
See [https://skycorp.global/skyscript/mods/v/96/sample-claim-ownership Claim Ownership] sample for an example of body description in use.<syntaxhighlight lang="lua">
-- Placed in global scope so it runs on load.
bodyDescription = BodyDescription.generateNew();
bodyDescription.setBreastSize(4); -- D Cup
bodyDescription.setBreastRows(2);
bodyDescription.setDickSize(10); -- Inches
bodyDescription.setVaginaSize(2);
bodyDescription.setUniqueBodyPartDescription("HANDS", "oversized paws");
bodyDescription.setUniqueBodyPartDescription("TEETH", "fangs");
-- etc...
this.setBodyDescription(bodyDescription);
</syntaxhighlight>

[[Category:LUA Class Reference]]

Modding:MainScreen

2026-02-04T02:04:57Z

SkyCorp: Add claim ownership sample mod link

== Public Methods ==

=== static void addGameText(string gameText) ===
Output string to screen. Does not automatically add newlines.

Unlike io.write, will only accept one string parameter, making it useful to get around the [[LUA Implementation Limitations & Notes|LUFA garbage array bug]].

=== static void continueSceneToMapScene() ===
Removes screen buttons (but not shown text). Will display one 'continue' button, which when pressed, will redirect flow back to the map (/ player navigation). This is a shortcut into the game's scene flow control that handles most cases, but for instance, if you wanted to continue then go to somewhere else, you should bug Skye to expose the full scene control system.

Added in r35

=== static void changeToForcedTransformationScene(string prefix, [[Modding:Species|Species]] species, bool allowEscape = true, function switchSceneAfterTransformationSequence = null, function teleportPlayerOnFinish = true, bool resetLustHP = true, function customOutputFunction = null, bool withContinueScene = true) ===
Using this, you can play the forced transformation sequence scene. This is primarily useful if you are doing a forced transformation sequence that should be triggered from customized monster logic (ex: not normal defeat logic) or triggered from an arbitrary object.

[https://skycorp.global/skyscript/mods/v/90/sample-fox-painting Sample code]

Note there are several other methods you may want to consider instead of this:

* If you just want to cause a single body part to be transformed at a time, see [[Modding:Species#void causeTF()|causeTF()]]
* If you do want a multi-step tf sequence, and are already triggering this on player defeat to a monster, you probably want to use the normal player defeat logic. This will also check to see if the player is TF'able before trying to TF the player, as well as updating the monster's state to sleep, and inseminating the player if configured. You can trigger this logic on defeat by either
** Not defining the doMonsterVictory function in the json, or
** Defining the doMonsterVictory function, but inside your custom function, calling doMonsterVictoryDefault() to do normal logic

If you do want to call this function, then you'll need to define the following text variables:
{| class="wikitable"
|+
!Text Variable
!Purpose
|-
|<PREFIX>_PLAYER_DEFEAT
|Initial text shown to player on defeat
|-
|<PREFIX>_DEFEAT_TFTIME
|Text shown every step player is being tf'ed
|-
|<PREFIX>_DEFEAT_TFTOTAL
|Text shown at conclusion of tf
|-
|<PREFIX>_DEFEAT_TFESCAPE_SUCCESS
|Player tried to escape, and did
|-
|<PREFIX>_DEFEAT_TFESCAPE_FAILURE
|Player tried to escape, but failed
|-
|<PREFIX>_DEFEAT_TFACCEPT
|Player did not try to escape / accepted the tf
|}
Function parameters:

==== string prefix ====
Defines the <PREFIX> part of the text keys, per the above table.

==== [[Modding:Species|Species]] species ====
Which TF is being done

==== bool allowEscape = true ====
If escape is possible. Button will still be shown, but it will be impossible to escape regardless of lust level.

==== function switchSceneAfterTransformationSequenceScript = null ====
This can be used to transition to a different scene after the sequence, instead of back to the normal mapscene.

If not null, called to determine logic for switching scene. (If not set, just goes back to mapscene). The bool indicates if the full tf played out (false if the player escaped mid-tf)

(Most users will just leave this as 'null')

==== function teleportPlayerOnFinish = true ====
Whether to teleport player to a respawn position after the sequence finishes

==== bool resetLustHP = true ====
On full tf: whether to reset lust + hp.

On early escape: whether to reset lust.

==== function customOutputFunctionScript = null ====
If set, this function is called with the text key suffix each tf instead of outputting monsterPrefix+suffix text. (Most users will just leave this as 'null')

==== bool withContinueScene = true ====
If true, prepends a continue scene prior to switching the scene to the TF sequence scene. (Set true if you already have text on screen player should have a chance to read first)

Added in r56.1

=== static void changeToClaimOwnershipScene([[Modding:Entity|Entity]] potentialOwner, string textPrefix, bool withContinueScene, bool sleepAfterward, function customAfterSceneScript = null) ===
Transitions to the claim ownership scene -- a scene that displays some intro text, information about the entity (presumably a dom/monster, but can be any entity), and then offers the player the ability to accept or reject them as their new owner. This scene already performs logic for handling if player is already owned by another dom and includes preset text variables.

You don't need to re-define text variables for this function (most monsters currently don't), but if you wish to, you should redefine these:
{| class="wikitable"
|+
!Text Variable
!Purpose
|-
|<PREFIX>_CLAIM_START
|Initial text, shown regardless of whether player has been claimed by some other dom or not.
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED
|After the initial text, the NPC will check if player is owned by someone else. There are multiple ways for this detection to happen, and this particular field overrides all of them.
If player is already owned by another dom, this text can be optionally defined if the NPC has some unusual way of identifying ownership over the player. Generally though it's safe to leave this undefined, and one of the standard identification methods below will be used instead.
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_SMELL
|If your dom can be smelled by any other dom
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_COLLAR_SLAVE
|Slave collar if player is wearing one
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_COLLAR_PET
|Pet collar if player is wearing one
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_GENERIC
|Generic fallback if none of the above apply
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_DETECT_END
|The above detection text is then followed by this
|-
|<PREFIX>_CLAIM_OK
|Scene for player accepting ownership
|-
|<PREFIX>_CLAIM_FAIL_RESIST
|Scene for player rejecting ownership
|}

==== [[Modding:Entity|Entity]] potentialOwner ====
The entity (probably a monster) who is trying to claim ownership over player

==== string textPrefix ====
Defines the <PREFIX> part of the text keys, per the above table.

==== bool withContinueScene ====
If true, prepends a continue scene prior to switching the scene to the TF sequence scene. (Set true if you already have text on screen player should have a chance to read first)

==== bool sleepAfterward ====
If true, monster will go to sleep after this scene. (This is ignored if customAfterSceneScript parameter is defined)

==== function customAfterSceneScript = null ====
Instead of doing default scene handling and going back to map, this function can be called instead. This lets you do some other scene or action instead.

Added in r56.1

Sample code: [https://skycorp.global/skyscript/mods/v/96/sample-claim-ownership Claim Ownership Sample Mod]

=== static void changeToSimpleDynamicOptionsScene([[Modding:DynamicOptions|DynamicOptions]] dynamicOptions) ===
Changes to simple dynamic options scene.

Unlike many other types of scenes, Simple Dynamic Options is similar to a 'continue' scene. That is, it will not clear text from the UI by itself. Furthermore (and unlike a continue scene), it also does not clear existing buttons by itself. It will, however, immediately add any buttons registered with the dynamic options object.

Sample: [https://skycorp.global/skyscript/mods/v/91/sample-dynamic-options-example DynamicOptionsExample]

Added in r56.1

=== static void resetUI(bool buttonsOnly=false) ===
Clears all text & buttons from user interface (make sure to add buttons back using some mechanism, or user will be stuck!)

If buttonsOnly is set, then only buttons will be cleared / text will not be cleared.

Added in r56.1

=== static void changeToMapScene() ===
Changes immediately to map scene, without continue. (This will cause any text currently on screen to be skipped)

Added in r56.1

=== static void changeToEntityLookScene([[Modding:Entity|Entity]] entity) ===
Changes immediately to looking at entity scene (where 'pick up', 'use', 'attack', etc are shown).

Added in r56.1
[[Category:LUA Class Reference]]

Modding Status

2026-01-31T01:37:30Z

SkyCorp: Present tense

The modding system has been ported over to the new engine. Here's a guide of what mod features have been implemented as of r45.

== Overall Features Status ==
Currently implemented:

* Simple monster mods (like [https://skycorp.global/skyscript/sclab.php SCLab] creates)
* Wyvern TF
*Advanced Monster Mods (including Wyvern doms)
*Entities
*Clothing
*Maps
*Custom species / transformation mods
*Mod <-> Mod communication

Currently not implemented:

* A few uncommonly used LUA features:
**Metatables

== Specific Mod Status ==
{| class="wikitable"
|+
Monster Mods

!Monster
!Status
|-
|Wolf Girl
|✅
|-
|Sholf
|✅
|-
|CrotchHugger
|✅ r45
|-
|Bolstered Dragon Disciple
|✅
|-
|Wyvern Male
|✅ r44
|-
|Wyvern Shemale (new variant)
|✅ r44
|-
|Sample: Monster Advanced Example
|✅ r44
|-
|Male Spider
|✅
|-
|Kitsune
|✅
|-
|Potent Dragon Servant
|✅
|-
|Pig King
|✅
|}
{| class="wikitable"
|+Clothing Mods
!Clothing
!Status
|-
|Weight Pendant
|✅ r44
|-
|Slacks
|✅ r44
|}
{| class="wikitable"
|+Map Mods
!Map
!Status
|-
|Spider Dungeon
|✅ r44
|}
 
{| class="wikitable"
|+Species/Transformation Mods
!Map
!Status
|-
|Wolf TF
|✅ r45
|-
|Giraffe TF
|✅ r45
|-
|Pig TF
|✅ r45
|-
|Crotchhugger TF
|✅ r45
|}

(I haven't had time to test every mod yet -- feel free to expand this status list :))

All mods are planned to be working again in future.

Modding Status

2026-01-31T01:37:01Z

SkyCorp: Mod <-> Mod communication re-implemented

The modding system is being ported over to the new engine. Here's a guide of what mod features have been implemented as of r45.

== Overall Features Status ==
Currently implemented:

* Simple monster mods (like [https://skycorp.global/skyscript/sclab.php SCLab] creates)
* Wyvern TF
*Advanced Monster Mods (including Wyvern doms)
*Entities
*Clothing
*Maps
*Custom species / transformation mods
*Mod <-> Mod communication

Currently not implemented:

* A few uncommonly used LUA features:
**Metatables

== Specific Mod Status ==
{| class="wikitable"
|+
Monster Mods

!Monster
!Status
|-
|Wolf Girl
|✅
|-
|Sholf
|✅
|-
|CrotchHugger
|✅ r45
|-
|Bolstered Dragon Disciple
|✅
|-
|Wyvern Male
|✅ r44
|-
|Wyvern Shemale (new variant)
|✅ r44
|-
|Sample: Monster Advanced Example
|✅ r44
|-
|Male Spider
|✅
|-
|Kitsune
|✅
|-
|Potent Dragon Servant
|✅
|-
|Pig King
|✅
|}
{| class="wikitable"
|+Clothing Mods
!Clothing
!Status
|-
|Weight Pendant
|✅ r44
|-
|Slacks
|✅ r44
|}
{| class="wikitable"
|+Map Mods
!Map
!Status
|-
|Spider Dungeon
|✅ r44
|}
 
{| class="wikitable"
|+Species/Transformation Mods
!Map
!Status
|-
|Wolf TF
|✅ r45
|-
|Giraffe TF
|✅ r45
|-
|Pig TF
|✅ r45
|-
|Crotchhugger TF
|✅ r45
|}

(I haven't had time to test every mod yet -- feel free to expand this status list :))

All mods are planned to be working again in future.

Modding:Map

2026-01-29T02:56:02Z

SkyCorp: Bunch of new map functions!

== Public Static Methods ==

=== static Map getMap(string mapName) ===
Gets map object from map name (string). Returns null if map with that name can not be found.

== Public Methods ==

=== boolean addItem([[Entity]] entity, int roomID) ===
Attempt adding entity to roomID.

More performant to use entity's

Called during drop item, could also be used to drop new items/loot/etc

=== boolean deleteItem([[Entity]] entity) ===
Attempt removing an item from anywhere in the map

Called from pickup. Could also be used to destroy an item in a room.

=== string getRoomName(int roomID) ===
Gets name of room. If no such room, returns "INVALID ROOM"

=== [[Entity]] getNamedEntityInRoom(string entityName, int roomID) ===
If the map has the named entity in the given roomID, return it. Else null.

=== [[Entity]] getEntityInRoomByType(class entityClass, int roomID) ===
TODO - not yet hooked up, need to figure out how to best pass class information between AS3/LUA.

=== void setTagBoolean(int roomID, string tag, boolean enabled) ===
Sets a tag for a room which can be useful for classifying rooms or applying special properties.

This version will set the tag to be either True or False (this system could be expanded in future to allow for string or other object storage inside tags)

Tags are used in a number of game locations to keep track of types of places. For instance, in the strip club, it is used to tag rooms where the patrons can see the player.

Parameters:
* roomID: room to change
* tag: tag name to change
* enabled: what to set tag state to (true/false) (false is same as unset)

=== boolean getTagBoolean(int roomID, string tag) ===
Gets a boolean tag for a certain room. False if room or tag does not exist, or is set to false. True if it exists and is set to true.

=== int getRoomIDOfEntity([[Entity]] entity) ===
Which room is a particular entity in? If not found, then 0

=== string getName() ===
Name of the map

=== [[Location]] createLocation(int roomID) ===
Returns the Location for a particular roomID on this map. Does not check the room ID actually exists.

(Introduced in r26)

=== void setupRoomIfNeeded(int roomID) ===
For better performance, the contents of a room is not typically loaded into memory until the player has visited it. This means the entities there are not accessible by code. This function can be called to load the contents of the room into memory without the player having to visit it.

Calling this function will have no effect on non-existent rooms or already loaded rooms.

(Introduced in r56.1)

=== bool isRoomSetup(int roomID) ===
Checks to see if the target room ID is loaded.

(Introduced in r56.1)

=== [[Modding:Entity|Entity]][] getAllEntitiesInRoom(int roomID) ===
Returns a list of all the entities in a given room. Returns empty list if nothing inside the room. Returns null if room is not yet loaded (see setupRoomIfNeeded)

Example code: [https://skycorp.global/skyscript/mods/v/93/sample-list-entities-in-room List all entities in room]

(Introduced in r56.1)

=== [[Modding:Entity|Entity]][] findEntitiesByNameSlow(string name, bool caseSensitive = true, [[Modding:NameType|NameType]] nameType = NameType.Unspecified) ===
Attempts to find all entities with a particular name. It's usually safer to find an entity based on type (though as of r56.1 this hasn't been exposed yet) as names are subject to change.

Returns all the entities with that name on the map.

(Introduced in r56.1)

=== [[Modding:Entity|Entity]] findEntityByNameSlow(string name, bool caseSensitive = true, [[Modding:NameType|NameType]] nameType = NameType.Unspecified) ===
Attempts to find an entity based on name. It's usually safer to find an entity based on type (though as of r56.1 this hasn't been exposed yet) as names are subject to change.

Returns the first entity with that name on the map.

(Introduced in r56.1)

=== table<character, [[Modding:Location|Location]]> getExits(int roomID) ===
Gets a table containing the exits for a particular room. If no such room, returns null. Otherwise, the character will be a cardinal direction abbreviation such as 'n', 'w', 'e', 's'. The location will be the linked location -- it may be on another map.

Example code: [https://skycorp.global/skyscript/mods/v/94/sample-list-room-exits List room exits]

(Introduced in r56.1)
[[Category:LUA Class Reference]]

Modding:CardinalDirection

2026-01-29T02:40:08Z

SkyCorp: Add parseFromCharacter()

[[Category:LUA Class Reference]]
This represents a specific map direction

== Static values ==
Each of these is a CardinalDirection:

* NORTH
* EAST
* SOUTH
* WEST
* WAIT (for pathfinding, route might still be calculating)
* UNKNOWN (for pathfinding, cannot route to destination)

== Static methods ==

=== static CardinalDirection parseDirection(string text) ===
Translate a string such as "NORTH" to CardinalDirection.North

Case sensitive.

=== static CardinalDirection parseFromCharacter(character text) ===
Translate a character such as "N" to CardinalDirection.North

(Note, lua does not actually have a character type, so this is just a normal one character long string.)

Case insensitive.

== Public methods ==

=== string toString() ===
Translates a cardinal direction object to an upper case string

=== CardinalDirection clockwise() ===
Gets the direction clockwise from this direction

=== CardinalDirection counterClockwise() ===
Gets the direction counter-clockwise from this direction

Modding:Entity

2026-01-29T00:54:30Z

SkyCorp: add return type

== Static Public Methods ==

=== static Entity generate(string entityName) ===
Generate a new entity of the given type based on the [[Types of Entities|entity type string]]. Null if unknown entity.

== Public Methods ==

=== string getName() ===
Gets name of entity

=== string getLookDesc() ===
Gets look description(the text displayed when looking at item)

=== boolean isExaminable() ===
Allow player to examine object? If so, the item is shown in the room item list. Otherwise, the object is invisible

=== boolean isAttackable() ===
Is player allowed to (attempt) to do an attack on this object -- shown when looking at object

=== boolean isUseable() ===
Is player shown a use button on this object -- shown when looking at object

=== boolean isPickupable() ===
Should object display a pick-up option if not yet in inventory? May or may not *actually* be pickupable. To do / attempt to do a pickup, use the [[Player]] class.

=== boolean isDropable() ===
Should object display a drop item button if is in inventory? May or may not *actually* be dropable. Use [[Player]] class to make the actual attempt.

=== void deleteEntity() ===
Removes entity from either the inventory or room that it exists in.

=== boolean isPlayerHere() ===
If entity is in world, is the player in this same room?

=== int isPlayerAdjacent() ===
If entity is in the world, is the player in a room adjacent to the one entity is in? If so, which room ID?

If not, room ID is 0. If player is in the same room, then room ID 0 is also returned.

=== [[Location]] getLocation() ===
Gets location of this entity. Returns null if entity is in inventory, or otherwise not in world.

=== void moveEntity(string newMapName:String, int newRoomID) ===
Moves entity from whereever it is (including inventory) into a particular location. If picking up the item, should use the functions on the Player class instead.

=== void moveEntityAdjacent([[Modding:CardinalDirection|CardinalDirection]] cardinalDirection, bool quiet = false) ===
Moves the entity to the adjacent room.Moves entity to new location.

If quiet is false, then it will announce the move to player if they are in entering or leaving room.

Exposed in r56.1

=== void moveEntityToSameRoomAsPlayer() ===
Move entity from wherever it is (including inventory) into the same room as the player is in.

=== void makeCursed() ===
Marks this entity as cursed. In order for this to have any effect, you should write a custom function for playerAttemptDropCheck.

Generally this would be called on start-up. Curse status can be modified by NPCs that can perform purification.

See [[Weight Pendant]] for an example of cursed items.

=== boolean getCursed() ===
Is this entity cursed?

=== [[Modding:BodyDescription|BodyDescription]] getBodyDescription() ===
Gets body description for this npc -- may be nil if no body description has been set.

Added in r56.1

== Private Methods ==

=== setBodyDescription([[Modding:BodyDescription|BodyDescription]] bodyDescription) ===
Sets/overwrites body description for this npc.

Added in r56.1

=== Default versions of functions ===
These are useful for calling if you want to do some logic first, and then fall back to the usual monster logic.

==== string defaultGetName([[Modding:NameType|NameType]] nameType = NameType.Unspecified) ====
As of r56.1, this is mostly useful to advanced monster mods, but is available to all entities. (Entities currently have no way to set the initial name value, so calling the default get name will just return "uninitialized entity". It is useful for advanced monster mods since they can set the name via 'initialValues' and thus access when UI name is supposed to be sleeping, etc.)

==== void defaultAddEntityLookOptions([[Modding:DynamicOptions|DynamicOptions]] dynamicOptions, [[Modding:Scene|Scene]] returnScene) ====
Adds commonly needed option to the passed dynamicOptions object for the entity look scene (pick-up, back button, attack, etc.)
[[Category:LUA Class Reference]]

Modding:Entity

2026-01-28T02:50:31Z

SkyCorp: Expose Entity.moveEntityAdjacent(...)

== Static Public Methods ==

=== static Entity generate(string entityName) ===
Generate a new entity of the given type based on the [[Types of Entities|entity type string]]. Null if unknown entity.

== Public Methods ==

=== string getName() ===
Gets name of entity

=== string getLookDesc() ===
Gets look description(the text displayed when looking at item)

=== boolean isExaminable() ===
Allow player to examine object? If so, the item is shown in the room item list. Otherwise, the object is invisible

=== boolean isAttackable() ===
Is player allowed to (attempt) to do an attack on this object -- shown when looking at object

=== boolean isUseable() ===
Is player shown a use button on this object -- shown when looking at object

=== boolean isPickupable() ===
Should object display a pick-up option if not yet in inventory? May or may not *actually* be pickupable. To do / attempt to do a pickup, use the [[Player]] class.

=== boolean isDropable() ===
Should object display a drop item button if is in inventory? May or may not *actually* be dropable. Use [[Player]] class to make the actual attempt.

=== void deleteEntity() ===
Removes entity from either the inventory or room that it exists in.

=== boolean isPlayerHere() ===
If entity is in world, is the player in this same room?

=== int isPlayerAdjacent() ===
If entity is in the world, is the player in a room adjacent to the one entity is in? If so, which room ID?

If not, room ID is 0. If player is in the same room, then room ID 0 is also returned.

=== [[Location]] getLocation() ===
Gets location of this entity. Returns null if entity is in inventory, or otherwise not in world.

=== void moveEntity(string newMapName:String, int newRoomID) ===
Moves entity from whereever it is (including inventory) into a particular location. If picking up the item, should use the functions on the Player class instead.

=== moveEntityAdjacent([[Modding:CardinalDirection|CardinalDirection]] cardinalDirection, bool quiet = false) ===
Moves the entity to the adjacent room.Moves entity to new location.

If quiet is false, then it will announce the move to player if they are in entering or leaving room.

Exposed in r56.1

=== void moveEntityToSameRoomAsPlayer() ===
Move entity from wherever it is (including inventory) into the same room as the player is in.

=== void makeCursed() ===
Marks this entity as cursed. In order for this to have any effect, you should write a custom function for playerAttemptDropCheck.

Generally this would be called on start-up. Curse status can be modified by NPCs that can perform purification.

See [[Weight Pendant]] for an example of cursed items.

=== boolean getCursed() ===
Is this entity cursed?

=== [[Modding:BodyDescription|BodyDescription]] getBodyDescription() ===
Gets body description for this npc -- may be nil if no body description has been set.

Added in r56.1

== Private Methods ==

=== setBodyDescription([[Modding:BodyDescription|BodyDescription]] bodyDescription) ===
Sets/overwrites body description for this npc.

Added in r56.1

=== Default versions of functions ===
These are useful for calling if you want to do some logic first, and then fall back to the usual monster logic.

==== string defaultGetName([[Modding:NameType|NameType]] nameType = NameType.Unspecified) ====
As of r56.1, this is mostly useful to advanced monster mods, but is available to all entities. (Entities currently have no way to set the initial name value, so calling the default get name will just return "uninitialized entity". It is useful for advanced monster mods since they can set the name via 'initialValues' and thus access when UI name is supposed to be sleeping, etc.)

==== void defaultAddEntityLookOptions([[Modding:DynamicOptions|DynamicOptions]] dynamicOptions, [[Modding:Scene|Scene]] returnScene) ====
Adds commonly needed option to the passed dynamicOptions object for the entity look scene (pick-up, back button, attack, etc.)
[[Category:LUA Class Reference]]

Modding:CardinalDirection

2026-01-28T02:47:36Z

SkyCorp: CardinalDirection exposed

[[Category:LUA Class Reference]]
This represents a specific map direction

== Static values ==
Each of these is a CardinalDirection:

* NORTH
* EAST
* SOUTH
* WEST
* WAIT (for pathfinding, route might still be calculating)
* UNKNOWN (for pathfinding, cannot route to destination)

== Static methods ==

=== static CardinalDirection parseDirection(string text) ===
Translate a string such as "NORTH" to CardinalDirection.North

Case sensitive.

== Public methods ==

=== string toString() ===
Translates a cardinal direction object to an upper case string

=== CardinalDirection clockwise() ===
Gets the direction clockwise from this direction

=== CardinalDirection counterClockwise() ===
Gets the direction counter-clockwise from this direction

Modding:NPCPathfindingLogic

2026-01-28T02:42:45Z

SkyCorp: Pathfinding exposed

[[Category:LUA Class Reference]]
This class can perform pathfinding logic and store the result. This variant is specifically designed for NPCs and other entities and can be used for them to path to other objects, locations, or the player.

Example code: Pathfinding Sample

== Static Public Methods ==

=== NPCPathfindingLogic generate([[Modding:Entity|Entity]] entity) ===
Creates new pathfinding.

entity - the entity which is using this to pathfind somewhere. (This will be used to determine the start of the path, and will be automatically updated as the entity moves around the map(s))

== Public Methods ==

=== void setDestination([[Modding:Location|Location]] destination) ===
Sets the place to navigate to. It is recommended to call this again anytime before getting the next direction (before moving). It will not incur a performance penalty to call it if the destination hasn't changed.

Okay to be nil if no destination.

=== [[Modding:CardinalDirection|CardinalDirection]] getNextDirection() ===
Calculate the route and determine the next direction this NPC would need to take to get there. An existing path is preferred as long as it is still valid.

It is capable of routing between multiple maps, if there is a path to do so.

=== int getRemainingDistance() ===
How many rooms distant is the destination from the NPC? Note, this does not update remaining distance, it only gets it as of the last move.

Modding:Scene

2026-01-22T03:00:20Z

SkyCorp: Add to LUA Class Reference category

A scene object is the representation of being able to receive button inputs and display text based on those inputs.

= Exposed methods =
Mods do not (currently) directly modify scene objects, so no methods are (currently) exposed.

= Scene management =
You may trigger these scenes via [[Modding:MainScreen|MainScreen]]:

* MapScene for moving around the world
* EntityLookScene for inspecting an object/enemy
* SimpleDynamicOptions lets you introduce your own scene logic

[[Category:LUA Class Reference]]

Modding:Scene

2026-01-22T02:59:50Z

SkyCorp: Some info on Scene

Modding:Entity

2026-01-22T02:53:07Z

SkyCorp: Added defaultAddEntityLookOptions

== Static Public Methods ==

=== static Entity generate(string entityName) ===
Generate a new entity of the given type based on the [[Types of Entities|entity type string]]. Null if unknown entity.

== Public Methods ==

=== string getName() ===
Gets name of entity

=== string getLookDesc() ===
Gets look description(the text displayed when looking at item)

=== boolean isExaminable() ===
Allow player to examine object? If so, the item is shown in the room item list. Otherwise, the object is invisible

=== boolean isAttackable() ===
Is player allowed to (attempt) to do an attack on this object -- shown when looking at object

=== boolean isUseable() ===
Is player shown a use button on this object -- shown when looking at object

=== boolean isPickupable() ===
Should object display a pick-up option if not yet in inventory? May or may not *actually* be pickupable. To do / attempt to do a pickup, use the [[Player]] class.

=== boolean isDropable() ===
Should object display a drop item button if is in inventory? May or may not *actually* be dropable. Use [[Player]] class to make the actual attempt.

=== void deleteEntity() ===
Removes entity from either the inventory or room that it exists in.

=== boolean isPlayerHere() ===
If entity is in world, is the player in this same room?

=== int isPlayerAdjacent() ===
If entity is in the world, is the player in a room adjacent to the one entity is in? If so, which room ID?

If not, room ID is 0. If player is in the same room, then room ID 0 is also returned.

=== [[Location]] getLocation() ===
Gets location of this entity. Returns null if entity is in inventory, or otherwise not in world.

=== void moveEntity(string newMapName:String, int newRoomID) ===
Moves entity from whereever it is (including inventory) into a particular location. If picking up the item, should use the functions on the Player class instead.

=== void moveEntityToSameRoomAsPlayer() ===
Move entity from wherever it is (including inventory) into the same room as the player is in.

=== void makeCursed() ===
Marks this entity as cursed. In order for this to have any effect, you should write a custom function for playerAttemptDropCheck.

Generally this would be called on start-up. Curse status can be modified by NPCs that can perform purification.

See [[Weight Pendant]] for an example of cursed items.

=== boolean getCursed() ===
Is this entity cursed?

=== [[Modding:BodyDescription|BodyDescription]] getBodyDescription() ===
Gets body description for this npc -- may be nil if no body description has been set.

Added in r56.1

== Private Methods ==

=== setBodyDescription([[Modding:BodyDescription|BodyDescription]] bodyDescription) ===
Sets/overwrites body description for this npc.

Added in r56.1

=== Default versions of functions ===
These are useful for calling if you want to do some logic first, and then fall back to the usual monster logic.

==== string defaultGetName([[Modding:NameType|NameType]] nameType = NameType.Unspecified) ====
As of r56.1, this is mostly useful to advanced monster mods, but is available to all entities. (Entities currently have no way to set the initial name value, so calling the default get name will just return "uninitialized entity". It is useful for advanced monster mods since they can set the name via 'initialValues' and thus access when UI name is supposed to be sleeping, etc.)

==== void defaultAddEntityLookOptions([[Modding:DynamicOptions|DynamicOptions]] dynamicOptions, [[Modding:Scene|Scene]] returnScene) ====
Adds commonly needed option to the passed dynamicOptions object for the entity look scene (pick-up, back button, attack, etc.)
[[Category:LUA Class Reference]]

Entity Mod JSON Format

2026-01-22T02:47:10Z

SkyCorp:

Entity JSON supports a variety of parameters to create custom objects.

== Fixed fields ==
A "'''type'''" of "ENTITY" should be used when creating an entity mod.

An optional "'''id'''" parameter can be used to refer to this type of entity (for instance in Entity.generate() to programmatically create additional entities). Be careful not to use the same id as another mod -- if you use the same mod name as your mod wiki page, you can be assured of no conflicts. (Introduced in r25)

An optional "'''customPublicFunctions'''" parameter is an array of custom lua functions that should be publicly available to other lua scripts. The [[Sample: Radio|radio sample]] shows an example of this. You can pass and return values, however, it's recommened to stick with primitive values when possible. Initial testing shows complex values like Tables and Entities are also okay to pass, but this is not well tested yet. (Introduced in r35)

== Dynamic fields ==
JSON definitions can specify each as programmable (LUA) or literal values.
{| class="wikitable"
!Return Type
!Parameter
|-
|string
|
=== name([[Modding:NameType|NameType]] nameType = NameType.Unspecified) ===
Title of the item.

A nametype may be parsed to differentiate which type of name is being requested (ex: a button name or dialogue name)

See also: [[Modding:Defining Names|Defining Names]]
|-
|string
|
=== description ===
Description of the item when looked at.
|-
|boolean
|
=== playerOnEnterRoom ===
Can be used to present some special text when player enters a room when this object is inside it or prevent the player from entering. But if it's not necessary to prevent player from entering, you may want to use the notify version of this function below.

Normally true. If false, will prevent mapscene from doing further room processing (be sure to use a continue scene)

As of r35, Lua function will receive these variables as parameters:

- currentRoom:String (however, currentRoom is placeholder. It can be queried for manually if needed based on entity current position)

- destinationRoom:String
|-
|boolean
|
=== playerAttemptLeaveRoom ===
Can be used to prevent player from leaving room when in same room as entity.

Normally true. If false, will prevent mapscene from doing further room processing (be sure to use a continue scene)

As of r35, Lua function will receive these variables as parameters:

- currentRoom:String (however, currentRoom is placeholder. It can be queried for manually if needed based on entity current position)

- destinationRoom:String

- destinationRoomID:int

(In r51, the internal way playerAttemptLeaveRoom() works changed to use Locations, however, the modding system has not yet been updated. If you need to use currentRoom or get map information, ask Skye to update this mod API for this function to use Locations also.)
|-
|boolean
|
=== isExaminable ===
Allow player to examine object? (This is the page description is displayed on. Otherwise will be invisible to player).
|-
|boolean
|
=== isUseable ===
Display the 'use' button on the examine item page?
|-
|void
|
=== addEntityLookOptions([[Modding:DynamicOptions|DynamicOptions]] dynamicOptions, [[Modding:Scene|Scene]] returnScene) ===
Provides a mechanism to add additional buttons (or completely change the buttons) on the entity look scene -- which is the scene shown when you examine an item or npc.

Usually you would want to call <code>this.defaultAddEntityLookOptions(dynamicOptions, returnScene);</code> to also include the normal buttons (pick up, back, etc).
* The return scene is the scene that is intended for the user to return to on pressing 'back' (usually map scene).
* dynamicOptions can be modified via its function call to add new options.

Sample: [https://skycorp.global/skyscript/mods/v/92/sample-entity-with-extra-look-buttons Entity with extra look options]

Added in r56.1
|-
|boolean
|

=== doUse ===
Action to do on using entity.

Usually should return true -- this will cause a continue scene after the text.

For a manual continue or a different scene change, return false.
|-
|boolean
|
=== isPickupable ===
Should a pick-up item be displayed on item page if item is in the world?
|-
|boolean
|
=== playerAttemptPickupCheck ===
Player has opted to pick up the item (may output descriptive message to screen)

Returns if successful in pickup attempt.
|-
|boolean
|
=== isDropable ===
Should a drop item be displayed on item page if item is in inventory?
|-
|boolean
|
=== playerAttemptDropCheck ===
Player has opted to drop the item. Return if successful in drop attempt.
|-
|void
|
=== inInventoryTick ===
Called each turn the item exists in the player's inventory.
|-
|void
|
===inWorldTick===
Called each turn the item exists on the map somewhere (may not be called if player is on a different map).
|-
|void
|
===notifyPlayerEnterRoom===
Notify object that player has just entered the same room as us.

Okay to output to screen - this is called after showScene() of the room.

As of r35, Lua function will receive these variables as parameters:

- arrivingFromRoom String name of room that was arrived from (before this room)

- arrivingFromRoomID ID of room arriving from (before this room)
|-
|void
|
===notifyPlayerEnterRoomPreScene===
Notify object that player has just entered the same room as us

This variant happens BEFORE showScene() is called, so is best for when entities are moving in/out based on player actions.

Don't output to screen using this call - it will be eaten by showScene()

As of r35, Lua function will receive these variables as parameters:

- arrivingFromRoom String name of room that was arrived from (before this room)

- arrivingFromRoomID ID of room arriving from (before this room)

|-
|void
|
===notifyPlayerLeftRoom===
Notify entity of the room the player is leaving that the player left successfully. Entities should not write to the screen since showScene() will immediately overwrite it.

The player's position has already been updated with the correct location by this point.

As of r35, Lua function will receive these variables as parameters:

- originalRoomName

- originalRoomID
|-
|string
|
===personalName()===
A name of them as a person (eg: 'Micky') as opposed to the general name above. This name would be used as the character refers to themselves. Ie, 'I am Micky' as opposed to 'I am Cowgirl Micky'. If you set this, normally the name field would be something more generic, like their species.

Normally when you first encounter an enemy, it just shows their generic type (ex: "AlphaSlug") as their button (UI Name), which is what the main name field is. Their dialogue might use their name (the "GameText" name, which pulls from this personalName field), and if they become your owner, their UI name likely becomes something like "<Honorific> <Personal Name>"

Note, if you set this (or usesRandomizedName() below), it is recommended to not set the overall name function. To set species/initial UI name, you can set the 'name' field in 'initialValues' instead of the 'name' function override.

See also: [[Modding:Defining Names|Defining Names]]

Introduced in r56.1
|-
|bool
|
===usesRandomizedName()===
If true, a randomized name will be assigned to this entity. The name will be a common one related to the assigned pronouns of the entity. (Mostly makes sense for NPCs)

Introduced in r56.1
|-
|string
|
===desiredPlayerSubmissiveType()===
Can define this if the npc is a dom to tell game text what sorts of sub types to use for its variables. Basically, what sort of dom/sub relationship will the npc form with the player, if the player accepts them as their owner?

Currently, the following sub types are supported:
*Sub (Default)
*Breeder
*Pet
*Slave

Any other string other than the above is currently not supported.

Introduced in r56.1
|-
|string
|
===pronoun()===
If an NPC, can set this to the character's pronouns so gametext variables can refer to them properly.

Currently, the following pronoun types are supported:
*Unspecified (default)
*He
*She
*Shi
*It
*They

Any other string other than the above is currently not supported.

Introduced in r56.1
|}

Entity Mod JSON Format

2026-01-22T02:45:46Z

SkyCorp: Fix formatting

Entity JSON supports a variety of parameters to create custom objects.

== Fixed fields ==
A "'''type'''" of "ENTITY" should be used when creating an entity mod.

An optional "'''id'''" parameter can be used to refer to this type of entity (for instance in Entity.generate() to programmatically create additional entities). Be careful not to use the same id as another mod -- if you use the same mod name as your mod wiki page, you can be assured of no conflicts. (Introduced in r25)

An optional "'''customPublicFunctions'''" parameter is an array of custom lua functions that should be publicly available to other lua scripts. The [[Sample: Radio|radio sample]] shows an example of this. You can pass and return values, however, it's recommened to stick with primitive values when possible. Initial testing shows complex values like Tables and Entities are also okay to pass, but this is not well tested yet. (Introduced in r35)

== Dynamic fields ==
JSON definitions can specify each as programmable (LUA) or literal values.
{| class="wikitable"
!Return Type
!Parameter
|-
|string
|
=== name([[Modding:NameType|NameType]] nameType = NameType.Unspecified) ===
Title of the item.

A nametype may be parsed to differentiate which type of name is being requested (ex: a button name or dialogue name)

See also: [[Modding:Defining Names|Defining Names]]
|-
|string
|
=== description ===
Description of the item when looked at.
|-
|boolean
|
=== playerOnEnterRoom ===
Can be used to present some special text when player enters a room when this object is inside it or prevent the player from entering. But if it's not necessary to prevent player from entering, you may want to use the notify version of this function below.

Normally true. If false, will prevent mapscene from doing further room processing (be sure to use a continue scene)

As of r35, Lua function will receive these variables as parameters:

- currentRoom:String (however, currentRoom is placeholder. It can be queried for manually if needed based on entity current position)

- destinationRoom:String
|-
|boolean
|
=== playerAttemptLeaveRoom ===
Can be used to prevent player from leaving room when in same room as entity.

Normally true. If false, will prevent mapscene from doing further room processing (be sure to use a continue scene)

As of r35, Lua function will receive these variables as parameters:

- currentRoom:String (however, currentRoom is placeholder. It can be queried for manually if needed based on entity current position)

- destinationRoom:String

- destinationRoomID:int

(In r51, the internal way playerAttemptLeaveRoom() works changed to use Locations, however, the modding system has not yet been updated. If you need to use currentRoom or get map information, ask Skye to update this mod API for this function to use Locations also.)
|-
|boolean
|
=== isExaminable ===
Allow player to examine object? (This is the page description is displayed on. Otherwise will be invisible to player).
|-
|boolean
|
=== isUseable ===
Display the 'use' button on the examine item page?
|-
|void
|
=== addEntityLookOptions([[Modding:DynamicOptions|DynamicOptions]] dynamicOptions, [[Modding:Scene|Scene]] returnScene) ===
Provides a mechanism to add additional buttons (or completely change the buttons) on the entity look scene -- which is the scene shown when you examine an item or npc.

Usually you would want to call <pre>this.defaultAddEntityLookOptions(dynamicOptions, returnScene);</pre> to also include the normal buttons (pick up, back, etc).

* The return scene is the scene that is intended for the user to return to on pressing 'back' (usually map scene).
* dynamicOptions can be modified via its function call to add new options.

Sample: [https://skycorp.global/skyscript/mods/v/92/sample-entity-with-extra-look-buttons Entity with extra look options]

Added in r56.1
|-
|boolean
|

=== doUse ===
Action to do on using entity.

Usually should return true -- this will cause a continue scene after the text.

For a manual continue or a different scene change, return false.
|-
|boolean
|
=== isPickupable ===
Should a pick-up item be displayed on item page if item is in the world?
|-
|boolean
|
=== playerAttemptPickupCheck ===
Player has opted to pick up the item (may output descriptive message to screen)

Returns if successful in pickup attempt.
|-
|boolean
|
=== isDropable ===
Should a drop item be displayed on item page if item is in inventory?
|-
|boolean
|
=== playerAttemptDropCheck ===
Player has opted to drop the item. Return if successful in drop attempt.
|-
|void
|
=== inInventoryTick ===
Called each turn the item exists in the player's inventory.
|-
|void
|
===inWorldTick===
Called each turn the item exists on the map somewhere (may not be called if player is on a different map).
|-
|void
|
===notifyPlayerEnterRoom===
Notify object that player has just entered the same room as us.

Okay to output to screen - this is called after showScene() of the room.

As of r35, Lua function will receive these variables as parameters:

- arrivingFromRoom String name of room that was arrived from (before this room)

- arrivingFromRoomID ID of room arriving from (before this room)
|-
|void
|
===notifyPlayerEnterRoomPreScene===
Notify object that player has just entered the same room as us

This variant happens BEFORE showScene() is called, so is best for when entities are moving in/out based on player actions.

Don't output to screen using this call - it will be eaten by showScene()

As of r35, Lua function will receive these variables as parameters:

- arrivingFromRoom String name of room that was arrived from (before this room)

- arrivingFromRoomID ID of room arriving from (before this room)

|-
|void
|
===notifyPlayerLeftRoom===
Notify entity of the room the player is leaving that the player left successfully. Entities should not write to the screen since showScene() will immediately overwrite it.

The player's position has already been updated with the correct location by this point.

As of r35, Lua function will receive these variables as parameters:

- originalRoomName

- originalRoomID
|-
|string
|
===personalName()===
A name of them as a person (eg: 'Micky') as opposed to the general name above. This name would be used as the character refers to themselves. Ie, 'I am Micky' as opposed to 'I am Cowgirl Micky'. If you set this, normally the name field would be something more generic, like their species.

Normally when you first encounter an enemy, it just shows their generic type (ex: "AlphaSlug") as their button (UI Name), which is what the main name field is. Their dialogue might use their name (the "GameText" name, which pulls from this personalName field), and if they become your owner, their UI name likely becomes something like "<Honorific> <Personal Name>"

Note, if you set this (or usesRandomizedName() below), it is recommended to not set the overall name function. To set species/initial UI name, you can set the 'name' field in 'initialValues' instead of the 'name' function override.

See also: [[Modding:Defining Names|Defining Names]]

Introduced in r56.1
|-
|bool
|
===usesRandomizedName()===
If true, a randomized name will be assigned to this entity. The name will be a common one related to the assigned pronouns of the entity. (Mostly makes sense for NPCs)

Introduced in r56.1
|-
|string
|
===desiredPlayerSubmissiveType()===
Can define this if the npc is a dom to tell game text what sorts of sub types to use for its variables. Basically, what sort of dom/sub relationship will the npc form with the player, if the player accepts them as their owner?

Currently, the following sub types are supported:
*Sub (Default)
*Breeder
*Pet
*Slave

Any other string other than the above is currently not supported.

Introduced in r56.1
|-
|string
|
===pronoun()===
If an NPC, can set this to the character's pronouns so gametext variables can refer to them properly.

Currently, the following pronoun types are supported:
*Unspecified (default)
*He
*She
*Shi
*It
*They

Any other string other than the above is currently not supported.

Introduced in r56.1
|}

Entity Mod JSON Format

2026-01-22T02:44:17Z

SkyCorp: /* addEntityLookOptions(DynamicOptions dynamicOptions, Scene returnScene) */

Entity JSON supports a variety of parameters to create custom objects.

== Fixed fields ==
A "'''type'''" of "ENTITY" should be used when creating an entity mod.

An optional "'''id'''" parameter can be used to refer to this type of entity (for instance in Entity.generate() to programmatically create additional entities). Be careful not to use the same id as another mod -- if you use the same mod name as your mod wiki page, you can be assured of no conflicts. (Introduced in r25)

An optional "'''customPublicFunctions'''" parameter is an array of custom lua functions that should be publicly available to other lua scripts. The [[Sample: Radio|radio sample]] shows an example of this. You can pass and return values, however, it's recommened to stick with primitive values when possible. Initial testing shows complex values like Tables and Entities are also okay to pass, but this is not well tested yet. (Introduced in r35)

== Dynamic fields ==
JSON definitions can specify each as programmable (LUA) or literal values.
{| class="wikitable"
!Return Type
!Parameter
|-
|string
|
=== name([[Modding:NameType|NameType]] nameType = NameType.Unspecified) ===
Title of the item.

A nametype may be parsed to differentiate which type of name is being requested (ex: a button name or dialogue name)

See also: [[Modding:Defining Names|Defining Names]]
|-
|string
|
=== description ===
Description of the item when looked at.
|-
|boolean
|
=== playerOnEnterRoom ===
Can be used to present some special text when player enters a room when this object is inside it or prevent the player from entering. But if it's not necessary to prevent player from entering, you may want to use the notify version of this function below.

Normally true. If false, will prevent mapscene from doing further room processing (be sure to use a continue scene)

As of r35, Lua function will receive these variables as parameters:

- currentRoom:String (however, currentRoom is placeholder. It can be queried for manually if needed based on entity current position)

- destinationRoom:String
|-
|boolean
|
=== playerAttemptLeaveRoom ===
Can be used to prevent player from leaving room when in same room as entity.

Normally true. If false, will prevent mapscene from doing further room processing (be sure to use a continue scene)

As of r35, Lua function will receive these variables as parameters:

- currentRoom:String (however, currentRoom is placeholder. It can be queried for manually if needed based on entity current position)

- destinationRoom:String

- destinationRoomID:int

(In r51, the internal way playerAttemptLeaveRoom() works changed to use Locations, however, the modding system has not yet been updated. If you need to use currentRoom or get map information, ask Skye to update this mod API for this function to use Locations also.)
|-
|boolean
|
=== isExaminable ===
Allow player to examine object? (This is the page description is displayed on. Otherwise will be invisible to player).
|-
|boolean
|
=== isUseable ===
Display the 'use' button on the examine item page?
|-
|void
|
=== addEntityLookOptions([[Modding:DynamicOptions|DynamicOptions]] dynamicOptions, [[Modding:Scene|Scene]] returnScene) ===
Provides a mechanism to add additional buttons (or completely change the buttons) on the entity look scene -- which is the scene shown when you examine an item or npc.

Usually you would want to call `this.defaultAddEntityLookOptions(dynamicOptions, returnScene);` to also include the normal buttons (pick up, back, etc).

- The return scene is the scene that is intended for the user to return to on pressing 'back' (usually map scene).
- dynamicOptions can be modified via its function call to add new options.

Sample: [https://skycorp.global/skyscript/mods/v/92/sample-entity-with-extra-look-buttons Entity with extra look options]

Added in r56.1
|-
|boolean
|

=== doUse ===
Action to do on using entity.

Usually should return true -- this will cause a continue scene after the text.

For a manual continue or a different scene change, return false.
|-
|boolean
|
=== isPickupable ===
Should a pick-up item be displayed on item page if item is in the world?
|-
|boolean
|
=== playerAttemptPickupCheck ===
Player has opted to pick up the item (may output descriptive message to screen)

Returns if successful in pickup attempt.
|-
|boolean
|
=== isDropable ===
Should a drop item be displayed on item page if item is in inventory?
|-
|boolean
|
=== playerAttemptDropCheck ===
Player has opted to drop the item. Return if successful in drop attempt.
|-
|void
|
=== inInventoryTick ===
Called each turn the item exists in the player's inventory.
|-
|void
|
===inWorldTick===
Called each turn the item exists on the map somewhere (may not be called if player is on a different map).
|-
|void
|
===notifyPlayerEnterRoom===
Notify object that player has just entered the same room as us.

Okay to output to screen - this is called after showScene() of the room.

As of r35, Lua function will receive these variables as parameters:

- arrivingFromRoom String name of room that was arrived from (before this room)

- arrivingFromRoomID ID of room arriving from (before this room)
|-
|void
|
===notifyPlayerEnterRoomPreScene===
Notify object that player has just entered the same room as us

This variant happens BEFORE showScene() is called, so is best for when entities are moving in/out based on player actions.

Don't output to screen using this call - it will be eaten by showScene()

As of r35, Lua function will receive these variables as parameters:

- arrivingFromRoom String name of room that was arrived from (before this room)

- arrivingFromRoomID ID of room arriving from (before this room)

|-
|void
|
===notifyPlayerLeftRoom===
Notify entity of the room the player is leaving that the player left successfully. Entities should not write to the screen since showScene() will immediately overwrite it.

The player's position has already been updated with the correct location by this point.

As of r35, Lua function will receive these variables as parameters:

- originalRoomName

- originalRoomID
|-
|string
|
===personalName()===
A name of them as a person (eg: 'Micky') as opposed to the general name above. This name would be used as the character refers to themselves. Ie, 'I am Micky' as opposed to 'I am Cowgirl Micky'. If you set this, normally the name field would be something more generic, like their species.

Normally when you first encounter an enemy, it just shows their generic type (ex: "AlphaSlug") as their button (UI Name), which is what the main name field is. Their dialogue might use their name (the "GameText" name, which pulls from this personalName field), and if they become your owner, their UI name likely becomes something like "<Honorific> <Personal Name>"

Note, if you set this (or usesRandomizedName() below), it is recommended to not set the overall name function. To set species/initial UI name, you can set the 'name' field in 'initialValues' instead of the 'name' function override.

See also: [[Modding:Defining Names|Defining Names]]

Introduced in r56.1
|-
|bool
|
===usesRandomizedName()===
If true, a randomized name will be assigned to this entity. The name will be a common one related to the assigned pronouns of the entity. (Mostly makes sense for NPCs)

Introduced in r56.1
|-
|string
|
===desiredPlayerSubmissiveType()===
Can define this if the npc is a dom to tell game text what sorts of sub types to use for its variables. Basically, what sort of dom/sub relationship will the npc form with the player, if the player accepts them as their owner?

Currently, the following sub types are supported:
*Sub (Default)
*Breeder
*Pet
*Slave

Any other string other than the above is currently not supported.

Introduced in r56.1
|-
|string
|
===pronoun()===
If an NPC, can set this to the character's pronouns so gametext variables can refer to them properly.

Currently, the following pronoun types are supported:
*Unspecified (default)
*He
*She
*Shi
*It
*They

Any other string other than the above is currently not supported.

Introduced in r56.1
|}

Entity Mod JSON Format

2026-01-22T02:43:01Z

SkyCorp: Fix formatting

Entity JSON supports a variety of parameters to create custom objects.

== Fixed fields ==
A "'''type'''" of "ENTITY" should be used when creating an entity mod.

An optional "'''id'''" parameter can be used to refer to this type of entity (for instance in Entity.generate() to programmatically create additional entities). Be careful not to use the same id as another mod -- if you use the same mod name as your mod wiki page, you can be assured of no conflicts. (Introduced in r25)

An optional "'''customPublicFunctions'''" parameter is an array of custom lua functions that should be publicly available to other lua scripts. The [[Sample: Radio|radio sample]] shows an example of this. You can pass and return values, however, it's recommened to stick with primitive values when possible. Initial testing shows complex values like Tables and Entities are also okay to pass, but this is not well tested yet. (Introduced in r35)

== Dynamic fields ==
JSON definitions can specify each as programmable (LUA) or literal values.
{| class="wikitable"
!Return Type
!Parameter
|-
|string
|
=== name([[Modding:NameType|NameType]] nameType = NameType.Unspecified) ===
Title of the item.

A nametype may be parsed to differentiate which type of name is being requested (ex: a button name or dialogue name)

See also: [[Modding:Defining Names|Defining Names]]
|-
|string
|
=== description ===
Description of the item when looked at.
|-
|boolean
|
=== playerOnEnterRoom ===
Can be used to present some special text when player enters a room when this object is inside it or prevent the player from entering. But if it's not necessary to prevent player from entering, you may want to use the notify version of this function below.

Normally true. If false, will prevent mapscene from doing further room processing (be sure to use a continue scene)

As of r35, Lua function will receive these variables as parameters:

- currentRoom:String (however, currentRoom is placeholder. It can be queried for manually if needed based on entity current position)

- destinationRoom:String
|-
|boolean
|
=== playerAttemptLeaveRoom ===
Can be used to prevent player from leaving room when in same room as entity.

Normally true. If false, will prevent mapscene from doing further room processing (be sure to use a continue scene)

As of r35, Lua function will receive these variables as parameters:

- currentRoom:String (however, currentRoom is placeholder. It can be queried for manually if needed based on entity current position)

- destinationRoom:String

- destinationRoomID:int

(In r51, the internal way playerAttemptLeaveRoom() works changed to use Locations, however, the modding system has not yet been updated. If you need to use currentRoom or get map information, ask Skye to update this mod API for this function to use Locations also.)
|-
|boolean
|
=== isExaminable ===
Allow player to examine object? (This is the page description is displayed on. Otherwise will be invisible to player).
|-
|boolean
|
=== isUseable ===
Display the 'use' button on the examine item page?
|-
|void
|
=== addEntityLookOptions([[Modding:DynamicOptions|DynamicOptions]] dynamicOptions, [[Modding:Scene|Scene]] returnScene) ===
Provides a mechanism to add additional buttons (or completely change the buttons) on the entity look scene -- which is the scene shown when you examine an item or npc.

The return scene is the scene that is intended for the user to return to on pressing 'back' (usually map scene).
dynamicOptions can be modified via its function call to add new options.

Sample: [https://skycorp.global/skyscript/mods/v/92/sample-entity-with-extra-look-buttons Entity with extra look options]

Added in r56.1
|-
|boolean
|
=== doUse ===
Action to do on using entity.

Usually should return true -- this will cause a continue scene after the text.

For a manual continue or a different scene change, return false.
|-
|boolean
|
=== isPickupable ===
Should a pick-up item be displayed on item page if item is in the world?
|-
|boolean
|
=== playerAttemptPickupCheck ===
Player has opted to pick up the item (may output descriptive message to screen)

Returns if successful in pickup attempt.
|-
|boolean
|
=== isDropable ===
Should a drop item be displayed on item page if item is in inventory?
|-
|boolean
|
=== playerAttemptDropCheck ===
Player has opted to drop the item. Return if successful in drop attempt.
|-
|void
|
=== inInventoryTick ===
Called each turn the item exists in the player's inventory.
|-
|void
|
===inWorldTick===
Called each turn the item exists on the map somewhere (may not be called if player is on a different map).
|-
|void
|
===notifyPlayerEnterRoom===
Notify object that player has just entered the same room as us.

Okay to output to screen - this is called after showScene() of the room.

As of r35, Lua function will receive these variables as parameters:

- arrivingFromRoom String name of room that was arrived from (before this room)

- arrivingFromRoomID ID of room arriving from (before this room)
|-
|void
|
===notifyPlayerEnterRoomPreScene===
Notify object that player has just entered the same room as us

This variant happens BEFORE showScene() is called, so is best for when entities are moving in/out based on player actions.

Don't output to screen using this call - it will be eaten by showScene()

As of r35, Lua function will receive these variables as parameters:

- arrivingFromRoom String name of room that was arrived from (before this room)

- arrivingFromRoomID ID of room arriving from (before this room)

|-
|void
|
===notifyPlayerLeftRoom===
Notify entity of the room the player is leaving that the player left successfully. Entities should not write to the screen since showScene() will immediately overwrite it.

The player's position has already been updated with the correct location by this point.

As of r35, Lua function will receive these variables as parameters:

- originalRoomName

- originalRoomID
|-
|string
|
===personalName()===
A name of them as a person (eg: 'Micky') as opposed to the general name above. This name would be used as the character refers to themselves. Ie, 'I am Micky' as opposed to 'I am Cowgirl Micky'. If you set this, normally the name field would be something more generic, like their species.

Normally when you first encounter an enemy, it just shows their generic type (ex: "AlphaSlug") as their button (UI Name), which is what the main name field is. Their dialogue might use their name (the "GameText" name, which pulls from this personalName field), and if they become your owner, their UI name likely becomes something like "<Honorific> <Personal Name>"

Note, if you set this (or usesRandomizedName() below), it is recommended to not set the overall name function. To set species/initial UI name, you can set the 'name' field in 'initialValues' instead of the 'name' function override.

See also: [[Modding:Defining Names|Defining Names]]

Introduced in r56.1
|-
|bool
|
===usesRandomizedName()===
If true, a randomized name will be assigned to this entity. The name will be a common one related to the assigned pronouns of the entity. (Mostly makes sense for NPCs)

Introduced in r56.1
|-
|string
|
===desiredPlayerSubmissiveType()===
Can define this if the npc is a dom to tell game text what sorts of sub types to use for its variables. Basically, what sort of dom/sub relationship will the npc form with the player, if the player accepts them as their owner?

Currently, the following sub types are supported:
*Sub (Default)
*Breeder
*Pet
*Slave

Any other string other than the above is currently not supported.

Introduced in r56.1
|-
|string
|
===pronoun()===
If an NPC, can set this to the character's pronouns so gametext variables can refer to them properly.

Currently, the following pronoun types are supported:
*Unspecified (default)
*He
*She
*Shi
*It
*They

Any other string other than the above is currently not supported.

Introduced in r56.1
|}

Entity Mod JSON Format

2026-01-22T02:42:03Z

SkyCorp: New Dynamic field: addEntityLookOptions

Entity JSON supports a variety of parameters to create custom objects.

== Fixed fields ==
A "'''type'''" of "ENTITY" should be used when creating an entity mod.

An optional "'''id'''" parameter can be used to refer to this type of entity (for instance in Entity.generate() to programmatically create additional entities). Be careful not to use the same id as another mod -- if you use the same mod name as your mod wiki page, you can be assured of no conflicts. (Introduced in r25)

An optional "'''customPublicFunctions'''" parameter is an array of custom lua functions that should be publicly available to other lua scripts. The [[Sample: Radio|radio sample]] shows an example of this. You can pass and return values, however, it's recommened to stick with primitive values when possible. Initial testing shows complex values like Tables and Entities are also okay to pass, but this is not well tested yet. (Introduced in r35)

== Dynamic fields ==
JSON definitions can specify each as programmable (LUA) or literal values.
{| class="wikitable"
!Return Type
!Parameter
|-
|string
|
=== name([[Modding:NameType|NameType]] nameType = NameType.Unspecified) ===
Title of the item.

A nametype may be parsed to differentiate which type of name is being requested (ex: a button name or dialogue name)

See also: [[Modding:Defining Names|Defining Names]]
|-
|string
|
=== description ===
Description of the item when looked at.
|-
|boolean
|
=== playerOnEnterRoom ===
Can be used to present some special text when player enters a room when this object is inside it or prevent the player from entering. But if it's not necessary to prevent player from entering, you may want to use the notify version of this function below.

Normally true. If false, will prevent mapscene from doing further room processing (be sure to use a continue scene)

As of r35, Lua function will receive these variables as parameters:

- currentRoom:String (however, currentRoom is placeholder. It can be queried for manually if needed based on entity current position)

- destinationRoom:String
|-
|boolean
|
=== playerAttemptLeaveRoom ===
Can be used to prevent player from leaving room when in same room as entity.

Normally true. If false, will prevent mapscene from doing further room processing (be sure to use a continue scene)

As of r35, Lua function will receive these variables as parameters:

- currentRoom:String (however, currentRoom is placeholder. It can be queried for manually if needed based on entity current position)

- destinationRoom:String

- destinationRoomID:int

(In r51, the internal way playerAttemptLeaveRoom() works changed to use Locations, however, the modding system has not yet been updated. If you need to use currentRoom or get map information, ask Skye to update this mod API for this function to use Locations also.)
|-
|boolean
|
=== isExaminable ===
Allow player to examine object? (This is the page description is displayed on. Otherwise will be invisible to player).
|-
|boolean
|
=== isUseable ===
Display the 'use' button on the examine item page?
|-
|void
|
=== addEntityLookOptions([[Modding:DynamicOptions|DynamicOptions]] dynamicOptions, [[Modding:Scene|Scene]] returnScene) ===
Provides a mechanism to add additional buttons (or completely change the buttons) on the entity look scene -- which is the scene shown when you examine an item or npc.
The return scene is the scene that is intended for the user to return to on pressing 'back' (usually map scene).
dynamicOptions can be modified via its function call to add new options.
Sample: [https://skycorp.global/skyscript/mods/v/92/sample-entity-with-extra-look-buttons Entity with extra look options]
|-
|boolean
|
=== doUse ===
Action to do on using entity.

Usually should return true -- this will cause a continue scene after the text.

For a manual continue or a different scene change, return false.
|-
|boolean
|
=== isPickupable ===
Should a pick-up item be displayed on item page if item is in the world?
|-
|boolean
|
=== playerAttemptPickupCheck ===
Player has opted to pick up the item (may output descriptive message to screen)

Returns if successful in pickup attempt.
|-
|boolean
|
=== isDropable ===
Should a drop item be displayed on item page if item is in inventory?
|-
|boolean
|
=== playerAttemptDropCheck ===
Player has opted to drop the item. Return if successful in drop attempt.
|-
|void
|
=== inInventoryTick ===
Called each turn the item exists in the player's inventory.
|-
|void
|
===inWorldTick===
Called each turn the item exists on the map somewhere (may not be called if player is on a different map).
|-
|void
|
===notifyPlayerEnterRoom===
Notify object that player has just entered the same room as us.

Okay to output to screen - this is called after showScene() of the room.

As of r35, Lua function will receive these variables as parameters:

- arrivingFromRoom String name of room that was arrived from (before this room)

- arrivingFromRoomID ID of room arriving from (before this room)
|-
|void
|
===notifyPlayerEnterRoomPreScene===
Notify object that player has just entered the same room as us

This variant happens BEFORE showScene() is called, so is best for when entities are moving in/out based on player actions.

Don't output to screen using this call - it will be eaten by showScene()

As of r35, Lua function will receive these variables as parameters:

- arrivingFromRoom String name of room that was arrived from (before this room)

- arrivingFromRoomID ID of room arriving from (before this room)

|-
|void
|
===notifyPlayerLeftRoom===
Notify entity of the room the player is leaving that the player left successfully. Entities should not write to the screen since showScene() will immediately overwrite it.

The player's position has already been updated with the correct location by this point.

As of r35, Lua function will receive these variables as parameters:

- originalRoomName

- originalRoomID
|-
|string
|
===personalName()===
A name of them as a person (eg: 'Micky') as opposed to the general name above. This name would be used as the character refers to themselves. Ie, 'I am Micky' as opposed to 'I am Cowgirl Micky'. If you set this, normally the name field would be something more generic, like their species.

Normally when you first encounter an enemy, it just shows their generic type (ex: "AlphaSlug") as their button (UI Name), which is what the main name field is. Their dialogue might use their name (the "GameText" name, which pulls from this personalName field), and if they become your owner, their UI name likely becomes something like "<Honorific> <Personal Name>"

Note, if you set this (or usesRandomizedName() below), it is recommended to not set the overall name function. To set species/initial UI name, you can set the 'name' field in 'initialValues' instead of the 'name' function override.

See also: [[Modding:Defining Names|Defining Names]]

Introduced in r56.1
|-
|bool
|
===usesRandomizedName()===
If true, a randomized name will be assigned to this entity. The name will be a common one related to the assigned pronouns of the entity. (Mostly makes sense for NPCs)

Introduced in r56.1
|-
|string
|
===desiredPlayerSubmissiveType()===
Can define this if the npc is a dom to tell game text what sorts of sub types to use for its variables. Basically, what sort of dom/sub relationship will the npc form with the player, if the player accepts them as their owner?

Currently, the following sub types are supported:
*Sub (Default)
*Breeder
*Pet
*Slave

Any other string other than the above is currently not supported.

Introduced in r56.1
|-
|string
|
===pronoun()===
If an NPC, can set this to the character's pronouns so gametext variables can refer to them properly.

Currently, the following pronoun types are supported:
*Unspecified (default)
*He
*She
*Shi
*It
*They

Any other string other than the above is currently not supported.

Introduced in r56.1
|}

Modding:MainScreen

2026-01-16T00:46:40Z

SkyCorp: Link some sample code

== Public Methods ==

=== static void addGameText(string gameText) ===
Output string to screen. Does not automatically add newlines.

Unlike io.write, will only accept one string parameter, making it useful to get around the [[LUA Implementation Limitations & Notes|LUFA garbage array bug]].

=== static void continueSceneToMapScene() ===
Removes screen buttons (but not shown text). Will display one 'continue' button, which when pressed, will redirect flow back to the map (/ player navigation). This is a shortcut into the game's scene flow control that handles most cases, but for instance, if you wanted to continue then go to somewhere else, you should bug Skye to expose the full scene control system.

Added in r35

=== static void changeToForcedTransformationScene(string prefix, [[Modding:Species|Species]] species, bool allowEscape = true, function switchSceneAfterTransformationSequence = null, function teleportPlayerOnFinish = true, bool resetLustHP = true, function customOutputFunction = null, bool withContinueScene = true) ===
Using this, you can play the forced transformation sequence scene. This is primarily useful if you are doing a forced transformation sequence that should be triggered from customized monster logic (ex: not normal defeat logic) or triggered from an arbitrary object.

[https://skycorp.global/skyscript/mods/v/90/sample-fox-painting Sample code]

Note there are several other methods you may want to consider instead of this:

* If you just want to cause a single body part to be transformed at a time, see [[Modding:Species#void causeTF()|causeTF()]]
* If you do want a multi-step tf sequence, and are already triggering this on player defeat to a monster, you probably want to use the normal player defeat logic. This will also check to see if the player is TF'able before trying to TF the player, as well as updating the monster's state to sleep, and inseminating the player if configured. You can trigger this logic on defeat by either
** Not defining the doMonsterVictory function in the json, or
** Defining the doMonsterVictory function, but inside your custom function, calling doMonsterVictoryDefault() to do normal logic

If you do want to call this function, then you'll need to define the following text variables:
{| class="wikitable"
|+
!Text Variable
!Purpose
|-
|<PREFIX>_PLAYER_DEFEAT
|Initial text shown to player on defeat
|-
|<PREFIX>_DEFEAT_TFTIME
|Text shown every step player is being tf'ed
|-
|<PREFIX>_DEFEAT_TFTOTAL
|Text shown at conclusion of tf
|-
|<PREFIX>_DEFEAT_TFESCAPE_SUCCESS
|Player tried to escape, and did
|-
|<PREFIX>_DEFEAT_TFESCAPE_FAILURE
|Player tried to escape, but failed
|-
|<PREFIX>_DEFEAT_TFACCEPT
|Player did not try to escape / accepted the tf
|}
Function parameters:

==== string prefix ====
Defines the <PREFIX> part of the text keys, per the above table.

==== [[Modding:Species|Species]] species ====
Which TF is being done

==== bool allowEscape = true ====
If escape is possible. Button will still be shown, but it will be impossible to escape regardless of lust level.

==== function switchSceneAfterTransformationSequenceScript = null ====
This can be used to transition to a different scene after the sequence, instead of back to the normal mapscene.

If not null, called to determine logic for switching scene. (If not set, just goes back to mapscene). The bool indicates if the full tf played out (false if the player escaped mid-tf)

(Most users will just leave this as 'null')

==== function teleportPlayerOnFinish = true ====
Whether to teleport player to a respawn position after the sequence finishes

==== bool resetLustHP = true ====
On full tf: whether to reset lust + hp.

On early escape: whether to reset lust.

==== function customOutputFunctionScript = null ====
If set, this function is called with the text key suffix each tf instead of outputting monsterPrefix+suffix text. (Most users will just leave this as 'null')

==== bool withContinueScene = true ====
If true, prepends a continue scene prior to switching the scene to the TF sequence scene. (Set true if you already have text on screen player should have a chance to read first)

Added in r56.1

=== static void changeToClaimOwnershipScene([[Modding:Entity|Entity]] potentialOwner, string textPrefix, bool withContinueScene, bool sleepAfterward, function customAfterSceneScript = null) ===
Transitions to the claim ownership scene -- a scene that displays some intro text, information about the entity (presumably a dom/monster, but can be any entity), and then offers the player the ability to accept or reject them as their new owner. This scene already performs logic for handling if player is already owned by another dom and includes preset text variables.

You don't need to re-define text variables for this function (most monsters currently don't), but if you wish to, you should redefine these:
{| class="wikitable"
|+
!Text Variable
!Purpose
|-
|<PREFIX>_CLAIM_START
|Initial text, shown regardless of whether player has been claimed by some other dom or not.
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED
|After the initial text, the NPC will check if player is owned by someone else. There are multiple ways for this detection to happen, and this particular field overrides all of them.
If player is already owned by another dom, this text can be optionally defined if the NPC has some unusual way of identifying ownership over the player. Generally though it's safe to leave this undefined, and one of the standard identification methods below will be used instead.
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_SMELL
|If your dom can be smelled by any other dom
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_COLLAR_SLAVE
|Slave collar if player is wearing one
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_COLLAR_PET
|Pet collar if player is wearing one
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_GENERIC
|Generic fallback if none of the above apply
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_DETECT_END
|The above detection text is then followed by this
|-
|<PREFIX>_CLAIM_OK
|Scene for player accepting ownership
|-
|<PREFIX>_CLAIM_FAIL_RESIST
|Scene for player rejecting ownership
|}

==== [[Modding:Entity|Entity]] potentialOwner ====
The entity (probably a monster) who is trying to claim ownership over player

==== string textPrefix ====
Defines the <PREFIX> part of the text keys, per the above table.

==== bool withContinueScene ====
If true, prepends a continue scene prior to switching the scene to the TF sequence scene. (Set true if you already have text on screen player should have a chance to read first)

==== bool sleepAfterward ====
If true, monster will go to sleep after this scene. (This is ignored if customAfterSceneScript parameter is defined)

==== function customAfterSceneScript = null ====
Instead of doing default scene handling and going back to map, this function can be called instead. This lets you do some other scene or action instead.

Added in r56.1

=== static void changeToSimpleDynamicOptionsScene([[Modding:DynamicOptions|DynamicOptions]] dynamicOptions) ===
Changes to simple dynamic options scene.

Unlike many other types of scenes, Simple Dynamic Options is similar to a 'continue' scene. That is, it will not clear text from the UI by itself. Furthermore (and unlike a continue scene), it also does not clear existing buttons by itself. It will, however, immediately add any buttons registered with the dynamic options object.

Sample: [https://skycorp.global/skyscript/mods/v/91/sample-dynamic-options-example DynamicOptionsExample]

Added in r56.1

=== static void resetUI(bool buttonsOnly=false) ===
Clears all text & buttons from user interface (make sure to add buttons back using some mechanism, or user will be stuck!)

If buttonsOnly is set, then only buttons will be cleared / text will not be cleared.

Added in r56.1

=== static void changeToMapScene() ===
Changes immediately to map scene, without continue. (This will cause any text currently on screen to be skipped)

Added in r56.1

=== static void changeToEntityLookScene([[Modding:Entity|Entity]] entity) ===
Changes immediately to looking at entity scene (where 'pick up', 'use', 'attack', etc are shown).

Added in r56.1
[[Category:LUA Class Reference]]

Modding:DynamicOptions

2026-01-16T00:46:02Z

SkyCorp: Documentation for DynamicOptions

Introduced in r56.1, this class provides a means to build customized scene flows in your mods.

This object holds a set of buttons that can be pushed to the UI.

Sample code: [https://skycorp.global/skyscript/mods/v/91/sample-dynamic-options-example DynamicOptionsExample]

== Public static methods ==

=== DynamicOptions generateNew() ===
Creates a new DynamicOptions

== Public methods ==

=== void clearOptions() ===
Removes all options/buttons from this object

(This does not immediately affect UI, see [[Modding:MainScreen|MainScreen]].resetUI() for that)

=== void addOption(string name, Closure onButtonScript, int preferredButtonLocation=-1) ===
Adds a new button to the collection.

name - The name for the button. Highly recommended to keep short or it will be unreadable.

onButtonScript - pass the function to be called if user presses the button. Usually just a function name, but you could create a lambda-style function, also.

preferredButtonLocation - An integer from 0-9, inclusive, will decide the button location. -1 will let the button go anywhere. If you plan to have a lot of buttons, just leave most of them as -1 and a dropdown will be created.

=== void showOptions() ===
Render options to MainScreen. This function assumes all buttons are already reset / non-enabled.

Modding:MainScreen

2026-01-16T00:35:39Z

SkyCorp: clarification

== Public Methods ==

=== static void addGameText(string gameText) ===
Output string to screen. Does not automatically add newlines.

Unlike io.write, will only accept one string parameter, making it useful to get around the [[LUA Implementation Limitations & Notes|LUFA garbage array bug]].

=== static void continueSceneToMapScene() ===
Removes screen buttons (but not shown text). Will display one 'continue' button, which when pressed, will redirect flow back to the map (/ player navigation). This is a shortcut into the game's scene flow control that handles most cases, but for instance, if you wanted to continue then go to somewhere else, you should bug Skye to expose the full scene control system.

Added in r35

=== static void changeToForcedTransformationScene(string prefix, [[Modding:Species|Species]] species, bool allowEscape = true, function switchSceneAfterTransformationSequence = null, function teleportPlayerOnFinish = true, bool resetLustHP = true, function customOutputFunction = null, bool withContinueScene = true) ===
Using this, you can play the forced transformation sequence scene. This is primarily useful if you are doing a forced transformation sequence that should be triggered from customized monster logic (ex: not normal defeat logic) or triggered from an arbitrary object.

[https://skycorp.global/skyscript/mods/v/90/sample-fox-painting Sample code]

Note there are several other methods you may want to consider instead of this:

* If you just want to cause a single body part to be transformed at a time, see [[Modding:Species#void causeTF()|causeTF()]]
* If you do want a multi-step tf sequence, and are already triggering this on player defeat to a monster, you probably want to use the normal player defeat logic. This will also check to see if the player is TF'able before trying to TF the player, as well as updating the monster's state to sleep, and inseminating the player if configured. You can trigger this logic on defeat by either
** Not defining the doMonsterVictory function in the json, or
** Defining the doMonsterVictory function, but inside your custom function, calling doMonsterVictoryDefault() to do normal logic

If you do want to call this function, then you'll need to define the following text variables:
{| class="wikitable"
|+
!Text Variable
!Purpose
|-
|<PREFIX>_PLAYER_DEFEAT
|Initial text shown to player on defeat
|-
|<PREFIX>_DEFEAT_TFTIME
|Text shown every step player is being tf'ed
|-
|<PREFIX>_DEFEAT_TFTOTAL
|Text shown at conclusion of tf
|-
|<PREFIX>_DEFEAT_TFESCAPE_SUCCESS
|Player tried to escape, and did
|-
|<PREFIX>_DEFEAT_TFESCAPE_FAILURE
|Player tried to escape, but failed
|-
|<PREFIX>_DEFEAT_TFACCEPT
|Player did not try to escape / accepted the tf
|}
Function parameters:

==== string prefix ====
Defines the <PREFIX> part of the text keys, per the above table.

==== [[Modding:Species|Species]] species ====
Which TF is being done

==== bool allowEscape = true ====
If escape is possible. Button will still be shown, but it will be impossible to escape regardless of lust level.

==== function switchSceneAfterTransformationSequenceScript = null ====
This can be used to transition to a different scene after the sequence, instead of back to the normal mapscene.

If not null, called to determine logic for switching scene. (If not set, just goes back to mapscene). The bool indicates if the full tf played out (false if the player escaped mid-tf)

(Most users will just leave this as 'null')

==== function teleportPlayerOnFinish = true ====
Whether to teleport player to a respawn position after the sequence finishes

==== bool resetLustHP = true ====
On full tf: whether to reset lust + hp.

On early escape: whether to reset lust.

==== function customOutputFunctionScript = null ====
If set, this function is called with the text key suffix each tf instead of outputting monsterPrefix+suffix text. (Most users will just leave this as 'null')

==== bool withContinueScene = true ====
If true, prepends a continue scene prior to switching the scene to the TF sequence scene. (Set true if you already have text on screen player should have a chance to read first)

Added in r56.1

=== static void changeToClaimOwnershipScene([[Modding:Entity|Entity]] potentialOwner, string textPrefix, bool withContinueScene, bool sleepAfterward, function customAfterSceneScript = null) ===
Transitions to the claim ownership scene -- a scene that displays some intro text, information about the entity (presumably a dom/monster, but can be any entity), and then offers the player the ability to accept or reject them as their new owner. This scene already performs logic for handling if player is already owned by another dom and includes preset text variables.

You don't need to re-define text variables for this function (most monsters currently don't), but if you wish to, you should redefine these:
{| class="wikitable"
|+
!Text Variable
!Purpose
|-
|<PREFIX>_CLAIM_START
|Initial text, shown regardless of whether player has been claimed by some other dom or not.
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED
|After the initial text, the NPC will check if player is owned by someone else. There are multiple ways for this detection to happen, and this particular field overrides all of them.
If player is already owned by another dom, this text can be optionally defined if the NPC has some unusual way of identifying ownership over the player. Generally though it's safe to leave this undefined, and one of the standard identification methods below will be used instead.
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_SMELL
|If your dom can be smelled by any other dom
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_COLLAR_SLAVE
|Slave collar if player is wearing one
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_COLLAR_PET
|Pet collar if player is wearing one
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_GENERIC
|Generic fallback if none of the above apply
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_DETECT_END
|The above detection text is then followed by this
|-
|<PREFIX>_CLAIM_OK
|Scene for player accepting ownership
|-
|<PREFIX>_CLAIM_FAIL_RESIST
|Scene for player rejecting ownership
|}

==== [[Modding:Entity|Entity]] potentialOwner ====
The entity (probably a monster) who is trying to claim ownership over player

==== string textPrefix ====
Defines the <PREFIX> part of the text keys, per the above table.

==== bool withContinueScene ====
If true, prepends a continue scene prior to switching the scene to the TF sequence scene. (Set true if you already have text on screen player should have a chance to read first)

==== bool sleepAfterward ====
If true, monster will go to sleep after this scene. (This is ignored if customAfterSceneScript parameter is defined)

==== function customAfterSceneScript = null ====
Instead of doing default scene handling and going back to map, this function can be called instead. This lets you do some other scene or action instead.

Added in r56.1

=== static void changeToSimpleDynamicOptionsScene([[Modding:DynamicOptions|DynamicOptions]] dynamicOptions) ===
Changes to simple dynamic options scene.

Unlike many other types of scenes, Simple Dynamic Options is similar to a 'continue' scene. That is, it will not clear text from the UI by itself. Furthermore (and unlike a continue scene), it also does not clear existing buttons by itself. It will, however, immediately add any buttons registered with the dynamic options object.

Example: DynamicOptionsExample

Added in r56.1

=== static void resetUI(bool buttonsOnly=false) ===
Clears all text & buttons from user interface (make sure to add buttons back using some mechanism, or user will be stuck!)

If buttonsOnly is set, then only buttons will be cleared / text will not be cleared.

Added in r56.1

=== static void changeToMapScene() ===
Changes immediately to map scene, without continue. (This will cause any text currently on screen to be skipped)

Added in r56.1

=== static void changeToEntityLookScene([[Modding:Entity|Entity]] entity) ===
Changes immediately to looking at entity scene (where 'pick up', 'use', 'attack', etc are shown).

Added in r56.1
[[Category:LUA Class Reference]]

Modding:MainScreen

2026-01-16T00:34:58Z

SkyCorp: documentation for changeToSimpleDynamicOptionsScene(...)

== Public Methods ==

=== static void addGameText(string gameText) ===
Output string to screen. Does not automatically add newlines.

Unlike io.write, will only accept one string parameter, making it useful to get around the [[LUA Implementation Limitations & Notes|LUFA garbage array bug]].

=== static void continueSceneToMapScene() ===
Removes screen buttons (but not shown text). Will display one 'continue' button, which when pressed, will redirect flow back to the map (/ player navigation). This is a shortcut into the game's scene flow control that handles most cases, but for instance, if you wanted to continue then go to somewhere else, you should bug Skye to expose the full scene control system.

Added in r35

=== static void changeToForcedTransformationScene(string prefix, [[Modding:Species|Species]] species, bool allowEscape = true, function switchSceneAfterTransformationSequence = null, function teleportPlayerOnFinish = true, bool resetLustHP = true, function customOutputFunction = null, bool withContinueScene = true) ===
Using this, you can play the forced transformation sequence scene. This is primarily useful if you are doing a forced transformation sequence that should be triggered from customized monster logic (ex: not normal defeat logic) or triggered from an arbitrary object.

[https://skycorp.global/skyscript/mods/v/90/sample-fox-painting Sample code]

Note there are several other methods you may want to consider instead of this:

* If you just want to cause a single body part to be transformed at a time, see [[Modding:Species#void causeTF()|causeTF()]]
* If you do want a multi-step tf sequence, and are already triggering this on player defeat to a monster, you probably want to use the normal player defeat logic. This will also check to see if the player is TF'able before trying to TF the player, as well as updating the monster's state to sleep, and inseminating the player if configured. You can trigger this logic on defeat by either
** Not defining the doMonsterVictory function in the json, or
** Defining the doMonsterVictory function, but inside your custom function, calling doMonsterVictoryDefault() to do normal logic

If you do want to call this function, then you'll need to define the following text variables:
{| class="wikitable"
|+
!Text Variable
!Purpose
|-
|<PREFIX>_PLAYER_DEFEAT
|Initial text shown to player on defeat
|-
|<PREFIX>_DEFEAT_TFTIME
|Text shown every step player is being tf'ed
|-
|<PREFIX>_DEFEAT_TFTOTAL
|Text shown at conclusion of tf
|-
|<PREFIX>_DEFEAT_TFESCAPE_SUCCESS
|Player tried to escape, and did
|-
|<PREFIX>_DEFEAT_TFESCAPE_FAILURE
|Player tried to escape, but failed
|-
|<PREFIX>_DEFEAT_TFACCEPT
|Player did not try to escape / accepted the tf
|}
Function parameters:

==== string prefix ====
Defines the <PREFIX> part of the text keys, per the above table.

==== [[Modding:Species|Species]] species ====
Which TF is being done

==== bool allowEscape = true ====
If escape is possible. Button will still be shown, but it will be impossible to escape regardless of lust level.

==== function switchSceneAfterTransformationSequenceScript = null ====
This can be used to transition to a different scene after the sequence, instead of back to the normal mapscene.

If not null, called to determine logic for switching scene. (If not set, just goes back to mapscene). The bool indicates if the full tf played out (false if the player escaped mid-tf)

(Most users will just leave this as 'null')

==== function teleportPlayerOnFinish = true ====
Whether to teleport player to a respawn position after the sequence finishes

==== bool resetLustHP = true ====
On full tf: whether to reset lust + hp.

On early escape: whether to reset lust.

==== function customOutputFunctionScript = null ====
If set, this function is called with the text key suffix each tf instead of outputting monsterPrefix+suffix text. (Most users will just leave this as 'null')

==== bool withContinueScene = true ====
If true, prepends a continue scene prior to switching the scene to the TF sequence scene. (Set true if you already have text on screen player should have a chance to read first)

Added in r56.1

=== static void changeToClaimOwnershipScene([[Modding:Entity|Entity]] potentialOwner, string textPrefix, bool withContinueScene, bool sleepAfterward, function customAfterSceneScript = null) ===
Transitions to the claim ownership scene -- a scene that displays some intro text, information about the entity (presumably a dom/monster, but can be any entity), and then offers the player the ability to accept or reject them as their new owner. This scene already performs logic for handling if player is already owned by another dom and includes preset text variables.

You don't need to re-define text variables for this function (most monsters currently don't), but if you wish to, you should redefine these:
{| class="wikitable"
|+
!Text Variable
!Purpose
|-
|<PREFIX>_CLAIM_START
|Initial text, shown regardless of whether player has been claimed by some other dom or not.
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED
|After the initial text, the NPC will check if player is owned by someone else. There are multiple ways for this detection to happen, and this particular field overrides all of them.
If player is already owned by another dom, this text can be optionally defined if the NPC has some unusual way of identifying ownership over the player. Generally though it's safe to leave this undefined, and one of the standard identification methods below will be used instead.
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_SMELL
|If your dom can be smelled by any other dom
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_COLLAR_SLAVE
|Slave collar if player is wearing one
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_COLLAR_PET
|Pet collar if player is wearing one
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_GENERIC
|Generic fallback if none of the above apply
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_DETECT_END
|The above detection text is then followed by this
|-
|<PREFIX>_CLAIM_OK
|Scene for player accepting ownership
|-
|<PREFIX>_CLAIM_FAIL_RESIST
|Scene for player rejecting ownership
|}

==== [[Modding:Entity|Entity]] potentialOwner ====
The entity (probably a monster) who is trying to claim ownership over player

==== string textPrefix ====
Defines the <PREFIX> part of the text keys, per the above table.

==== bool withContinueScene ====
If true, prepends a continue scene prior to switching the scene to the TF sequence scene. (Set true if you already have text on screen player should have a chance to read first)

==== bool sleepAfterward ====
If true, monster will go to sleep after this scene. (This is ignored if customAfterSceneScript parameter is defined)

==== function customAfterSceneScript = null ====
Instead of doing default scene handling and going back to map, this function can be called instead. This lets you do some other scene or action instead.

Added in r56.1

=== static void changeToSimpleDynamicOptionsScene([[Modding:DynamicOptions|DynamicOptions]] dynamicOptions) ===
Changes to simple dynamic options scene.

Unlike many other types of scenes, Simple Dynamic Options is similar to a 'continue' scene. That is, it will not clear text from the UI by itself. Furthermore, it also does not clear existing buttons by itself. It will, however, immediately add any buttons registered with the dynamic options object.

Example: DynamicOptionsExample

Added in r56.1

=== static void resetUI(bool buttonsOnly=false) ===
Clears all text & buttons from user interface (make sure to add buttons back using some mechanism, or user will be stuck!)

If buttonsOnly is set, then only buttons will be cleared / text will not be cleared.

Added in r56.1

=== static void changeToMapScene() ===
Changes immediately to map scene, without continue. (This will cause any text currently on screen to be skipped)

Added in r56.1

=== static void changeToEntityLookScene([[Modding:Entity|Entity]] entity) ===
Changes immediately to looking at entity scene (where 'pick up', 'use', 'attack', etc are shown).

Added in r56.1
[[Category:LUA Class Reference]]

Modding:MainScreen

2026-01-16T00:31:57Z

SkyCorp: New modding functions added to MainScreen

== Public Methods ==

=== static void addGameText(string gameText) ===
Output string to screen. Does not automatically add newlines.

Unlike io.write, will only accept one string parameter, making it useful to get around the [[LUA Implementation Limitations & Notes|LUFA garbage array bug]].

=== static void continueSceneToMapScene() ===
Removes screen buttons (but not shown text). Will display one 'continue' button, which when pressed, will redirect flow back to the map (/ player navigation). This is a shortcut into the game's scene flow control that handles most cases, but for instance, if you wanted to continue then go to somewhere else, you should bug Skye to expose the full scene control system.

Added in r35

=== static void changeToForcedTransformationScene(string prefix, [[Modding:Species|Species]] species, bool allowEscape = true, function switchSceneAfterTransformationSequence = null, function teleportPlayerOnFinish = true, bool resetLustHP = true, function customOutputFunction = null, bool withContinueScene = true) ===
Using this, you can play the forced transformation sequence scene. This is primarily useful if you are doing a forced transformation sequence that should be triggered from customized monster logic (ex: not normal defeat logic) or triggered from an arbitrary object.

[https://skycorp.global/skyscript/mods/v/90/sample-fox-painting Sample code]

Note there are several other methods you may want to consider instead of this:

* If you just want to cause a single body part to be transformed at a time, see [[Modding:Species#void causeTF()|causeTF()]]
* If you do want a multi-step tf sequence, and are already triggering this on player defeat to a monster, you probably want to use the normal player defeat logic. This will also check to see if the player is TF'able before trying to TF the player, as well as updating the monster's state to sleep, and inseminating the player if configured. You can trigger this logic on defeat by either
** Not defining the doMonsterVictory function in the json, or
** Defining the doMonsterVictory function, but inside your custom function, calling doMonsterVictoryDefault() to do normal logic

If you do want to call this function, then you'll need to define the following text variables:
{| class="wikitable"
|+
!Text Variable
!Purpose
|-
|<PREFIX>_PLAYER_DEFEAT
|Initial text shown to player on defeat
|-
|<PREFIX>_DEFEAT_TFTIME
|Text shown every step player is being tf'ed
|-
|<PREFIX>_DEFEAT_TFTOTAL
|Text shown at conclusion of tf
|-
|<PREFIX>_DEFEAT_TFESCAPE_SUCCESS
|Player tried to escape, and did
|-
|<PREFIX>_DEFEAT_TFESCAPE_FAILURE
|Player tried to escape, but failed
|-
|<PREFIX>_DEFEAT_TFACCEPT
|Player did not try to escape / accepted the tf
|}
Function parameters:

==== string prefix ====
Defines the <PREFIX> part of the text keys, per the above table.

==== [[Modding:Species|Species]] species ====
Which TF is being done

==== bool allowEscape = true ====
If escape is possible. Button will still be shown, but it will be impossible to escape regardless of lust level.

==== function switchSceneAfterTransformationSequenceScript = null ====
This can be used to transition to a different scene after the sequence, instead of back to the normal mapscene.

If not null, called to determine logic for switching scene. (If not set, just goes back to mapscene). The bool indicates if the full tf played out (false if the player escaped mid-tf)

(Most users will just leave this as 'null')

==== function teleportPlayerOnFinish = true ====
Whether to teleport player to a respawn position after the sequence finishes

==== bool resetLustHP = true ====
On full tf: whether to reset lust + hp.

On early escape: whether to reset lust.

==== function customOutputFunctionScript = null ====
If set, this function is called with the text key suffix each tf instead of outputting monsterPrefix+suffix text. (Most users will just leave this as 'null')

==== bool withContinueScene = true ====
If true, prepends a continue scene prior to switching the scene to the TF sequence scene. (Set true if you already have text on screen player should have a chance to read first)

Added in r56.1

=== static void changeToClaimOwnershipScene([[Modding:Entity|Entity]] potentialOwner, string textPrefix, bool withContinueScene, bool sleepAfterward, function customAfterSceneScript = null) ===
Transitions to the claim ownership scene -- a scene that displays some intro text, information about the entity (presumably a dom/monster, but can be any entity), and then offers the player the ability to accept or reject them as their new owner. This scene already performs logic for handling if player is already owned by another dom and includes preset text variables.

You don't need to re-define text variables for this function (most monsters currently don't), but if you wish to, you should redefine these:
{| class="wikitable"
|+
!Text Variable
!Purpose
|-
|<PREFIX>_CLAIM_START
|Initial text, shown regardless of whether player has been claimed by some other dom or not.
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED
|After the initial text, the NPC will check if player is owned by someone else. There are multiple ways for this detection to happen, and this particular field overrides all of them.
If player is already owned by another dom, this text can be optionally defined if the NPC has some unusual way of identifying ownership over the player. Generally though it's safe to leave this undefined, and one of the standard identification methods below will be used instead.
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_SMELL
|If your dom can be smelled by any other dom
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_COLLAR_SLAVE
|Slave collar if player is wearing one
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_COLLAR_PET
|Pet collar if player is wearing one
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_OWNED_DETECT_GENERIC
|Generic fallback if none of the above apply
|-
|<PREFIX>_CLAIM_FAIL_ALREADY_DETECT_END
|The above detection text is then followed by this
|-
|<PREFIX>_CLAIM_OK
|Scene for player accepting ownership
|-
|<PREFIX>_CLAIM_FAIL_RESIST
|Scene for player rejecting ownership
|}

==== [[Modding:Entity|Entity]] potentialOwner ====
The entity (probably a monster) who is trying to claim ownership over player

==== string textPrefix ====
Defines the <PREFIX> part of the text keys, per the above table.

==== bool withContinueScene ====
If true, prepends a continue scene prior to switching the scene to the TF sequence scene. (Set true if you already have text on screen player should have a chance to read first)

==== bool sleepAfterward ====
If true, monster will go to sleep after this scene. (This is ignored if customAfterSceneScript parameter is defined)

==== function customAfterSceneScript = null ====
Instead of doing default scene handling and going back to map, this function can be called instead. This lets you do some other scene or action instead.

Added in r56.1

=== static void changeToSimpleDynamicOptionsScene([[Modding:DynamicOptions|DynamicOptions]] dynamicOptions) ===
Added in r56.1

=== static void resetUI(bool buttonsOnly=false) ===
Clears all text & buttons from user interface (make sure to add buttons back using some mechanism, or user will be stuck!)

If buttonsOnly is set, then only buttons will be cleared / text will not be cleared.

Added in r56.1

=== static void changeToMapScene() ===
Changes immediately to map scene, without continue. (This will cause any text currently on screen to be skipped)

Added in r56.1

=== static void changeToEntityLookScene([[Modding:Entity|Entity]] entity) ===
Changes immediately to looking at entity scene (where 'pick up', 'use', 'attack', etc are shown).

Added in r56.1
[[Category:LUA Class Reference]]

Modding:GameText

2026-01-15T22:40:04Z

SkyCorp: More parameters for parseText(...)

[[File:TextEditorScreenshot.png|thumb|
An example of text key/value pairs from the text editor.
]]

Game Text is a key-value dictionary that stores much of the game's text. Keys are all uppercase, containing no spaces, but do contain underscores.

There can be multiple dictionaries loaded, but it is expected that text keys are unique across all dictionaries, so multiple dictionaries are essentially one big dictionary. Currently there is one for private builds, one for public+privates builds, and an "override" dictionary which code can use to override dictionary values at run-time. In this way, AS3 or LUA code can change just about any string in the game. However, it is not recommended to change shared text in this way as multiple mods accessing the same text may conflict with each other, leading to unexpected results

Generally, Game Text values should not include a trailing paragraph (\n\n) as that is added via the withParagraph parameter.

In future, I would like to provide a mod type for UGC game text dictionaries. For now you can add your own via setTextOverride during startup. It is recommended that you set a keys like MOD_NAME_ACTION_NAME to prevent colliding with existing game text or other mods.
== Public Static Methods ==

=== static string parseText(string unparsedText, string parameter="UnknownParameter", [[Modding:Entity|Entity]] npc=null) ===
Parses text and returns the result. See ''[[Text Variables]]''.

'parameter' allows you to pass a custom parameter that can be embedded into the text variables

'npc' is needed for some npc-specific text variables to work (like <nowiki>[[NPC NAME]]</nowiki>, etc)

=== static boolean hasText(string textKey) ===
Does specified text key exist in any loaded dictionary?

=== static void printText(string textKey, [boolean withParagraph=true]) ===
Gets the text for textKey, parses the text using ParseText, then prints it to screen. If withParagraph is true or unset, then a paragraph is added

=== static string getText(string textKey, [boolean withParagraph=true]) ===
Gets parsed text from either game text or game text private

=== static string getTextRaw(string textKey) ===
Gets UNPARSED raw text from text stores.

=== static void setTextOverride(string textKey, string value) ===
Allows a text key to be overridden with value. See notes in page header about proper usage!
[[Category:LUA Class Reference]]

Modding:BodyDescription

2026-01-09T22:57:00Z

SkyCorp: Small typo fix

This class lets you describe an NPC's appearance. [[Modding:Text Variables|Text variables]] can then use this appearance data in scenes.

== Static Methods ==

=== static public BodyDescription generateNew() ===
Creates a new body description.

Note that it must be assigned to the NPC after you finish configuring it!

== Public Methods ==

=== void setBreastSize(int breastSize) ===
Size of breasts -- uses same scale used by player class

=== int getBreastSize() ===

=== void setBreastRows(int breastRows) ===
Number of rows of breasts

=== int getBreastRows() ===

=== void setDickSize(int dickSize) ===
Size of dick -- uses same scale as player class

=== int getDickSize() ===

=== void setVaginaSize(int vaginaSize) ===
Size of vagina -- uses same scale as player class

=== int getVaginaSize() ===

=== void setDexterous(bool dexterous) ===
Does the character have dexterous hands? False if no hands, hands are bound, or non-dexterous paws

=== bool isDexterous() ===

=== bool getHasAlternateVoice() ===
If the NPC is incapable of normal human speech (also see Vocal string below).

=== void setHasAlternateVoice(bool hasAlternateVoice) ===

=== string getAlternateVocalString() ===
If NPC is incapable of normal human speech (alternate vocal bool above), then what noise do they produce instead?

=== void setAlternateVocalString(string alternateVocalString) ===

=== bool getBipedal() ===
If the NPC walks on two legs

=== void setBipedal(bool bipedal) ===

=== void setUniqueBodyPartDescription(string bodyPartName, string description) ===
Can set a description for a body part for specific flavor.

=== string getBodyPartDescription(string bodyPartName) ===
Tries to get the body part description, if one is defined. If unavailable, just returns ""

== Sample code ==
See SetOwnerWithScene sample for an example of body description in use.<syntaxhighlight lang="lua">
-- Placed in global scope so it runs on load.
bodyDescription = BodyDescription.generateNew();
bodyDescription.setBreastSize(4); -- D Cup
bodyDescription.setBreastRows(2);
bodyDescription.setDickSize(10); -- Inches
bodyDescription.setVaginaSize(2);
bodyDescription.setUniqueBodyPartDescription("HANDS", "oversized paws");
bodyDescription.setUniqueBodyPartDescription("TEETH", "fangs");
-- etc...
this.setBodyDescription(bodyDescription);
</syntaxhighlight>

[[Category:LUA Class Reference]]

Modding:Entity

2026-01-09T22:56:18Z

SkyCorp: Add get/set body description functions

== Static Public Methods ==

=== static Entity generate(string entityName) ===
Generate a new entity of the given type based on the [[Types of Entities|entity type string]]. Null if unknown entity.

== Public Methods ==

=== string getName() ===
Gets name of entity

=== string getLookDesc() ===
Gets look description(the text displayed when looking at item)

=== boolean isExaminable() ===
Allow player to examine object? If so, the item is shown in the room item list. Otherwise, the object is invisible

=== boolean isAttackable() ===
Is player allowed to (attempt) to do an attack on this object -- shown when looking at object

=== boolean isUseable() ===
Is player shown a use button on this object -- shown when looking at object

=== boolean isPickupable() ===
Should object display a pick-up option if not yet in inventory? May or may not *actually* be pickupable. To do / attempt to do a pickup, use the [[Player]] class.

=== boolean isDropable() ===
Should object display a drop item button if is in inventory? May or may not *actually* be dropable. Use [[Player]] class to make the actual attempt.

=== void deleteEntity() ===
Removes entity from either the inventory or room that it exists in.

=== boolean isPlayerHere() ===
If entity is in world, is the player in this same room?

=== int isPlayerAdjacent() ===
If entity is in the world, is the player in a room adjacent to the one entity is in? If so, which room ID?

If not, room ID is 0. If player is in the same room, then room ID 0 is also returned.

=== [[Location]] getLocation() ===
Gets location of this entity. Returns null if entity is in inventory, or otherwise not in world.

=== void moveEntity(string newMapName:String, int newRoomID) ===
Moves entity from whereever it is (including inventory) into a particular location. If picking up the item, should use the functions on the Player class instead.

=== void moveEntityToSameRoomAsPlayer() ===
Move entity from wherever it is (including inventory) into the same room as the player is in.

=== void makeCursed() ===
Marks this entity as cursed. In order for this to have any effect, you should write a custom function for playerAttemptDropCheck.

Generally this would be called on start-up. Curse status can be modified by NPCs that can perform purification.

See [[Weight Pendant]] for an example of cursed items.

=== boolean getCursed() ===
Is this entity cursed?

=== [[Modding:BodyDescription|BodyDescription]] getBodyDescription() ===
Gets body description for this npc -- may be nil if no body description has been set.

Added in r56.1

== Private Methods ==

=== setBodyDescription([[Modding:BodyDescription|BodyDescription]] bodyDescription) ===
Sets/overwrites body description for this npc.

Added in r56.1

=== Default versions of functions ===
These are useful for calling if you want to do some logic first, and then fall back to the usual monster logic.

==== string defaultGetName([[Modding:NameType|NameType]] nameType = NameType.Unspecified) ====
As of r56.1, this is mostly useful to advanced monster mods, but is available to all entities. (Entities currently have no way to set the initial name value, so calling the default get name will just return "uninitialized entity". It is useful for advanced monster mods since they can set the name via 'initialValues' and thus access when UI name is supposed to be sleeping, etc.)
[[Category:LUA Class Reference]]

Modding:BodyDescription

2026-01-09T22:52:26Z

SkyCorp: Also tag for lua class reference page category

This class lets you describe an NPC's appearance. [[Modding:Text Variables|Text variables]] can then use this appearance data in scenes.

== Static Methods ==

=== static public BodyDescription generateNew() ===
Creates a new body description.

Note that it must be assigned to the NPC after you finish configuring it!

== Public Methods ==

=== void setBreastSize(int breastSize) ===
Size of breasts -- uses same scale used by player class

=== int getBreastSize() ===

=== void setBreastRows(int breastRows) ===
Number of rows of breasts

=== int getBreastRows() ===

=== void setDickSize(int dickSize) ===
Size of dick -- uses same scale as player class

=== int getDickSize() ===

=== void setVaginaSize(int vaginaSize) ===
Size of vagina -- uses same scale as player class

=== int getVaginaSize() ===

=== void setDexterous(bool dexterous) ===
Does the character have dexterous hands? False if no hands, hands are bound, or non-dexterous paws

=== bool isDexterous() ===

=== bool getHasAlternateVoice() ===
If the NPC is incapable of normal human speech (also see Vocal string below).

=== void setHasAlternateVoice(bool hasAlternateVoice) ===

=== string getAlternateVocalString() ===
If NPC is incapable of normal human speech (alternate vocal bool above), then what noise do they produce instead?

=== void setAlternateVocalString(string alternateVocalString) ===

=== bool getBipedal() ===
If the NPC walks on two legs

=== void setBipedal(bool bipedal) ===

=== void setUniqueBodyPartDescription(string bodyPartName, string description) ===
Can set a description for a body part for specific flavor.

=== string getBodyPartDescription(string bodyPartName) ===
Tries to get the body part description, if one is defined. If unavailable, just returns ""

== Sample code ==
See SetOwnerWithScene sample for an example of body description in use.<syntaxhighlight lang="lua">
-- Placed in global scope so it runs on load.
bodyDescription = BodyDescription.generateNew();
bodyDescription.setBreastSize(4); -- D Cup
bodyDescription.setBreastRows(2);
bodyDescription.setDickSize(10); -- Inches
bodyDescription.setVaginaSize(2);
bodyDescription.setUniqueBodyPartDescription("HANDS", "oversized paws");
bodyDescription.setUniqueBodyPartDescription("TEETH", "fangs");
-- etc...
this.setBodyPartDescription(bodyDescription);
</syntaxhighlight>

[[Category:LUA Class Reference]]

Modding:BodyDescription

2026-01-09T22:51:41Z

SkyCorp: Body description lua class

This class lets you describe an NPC's appearance. [[Modding:Text Variables|Text variables]] can then use this appearance data in scenes.

== Static Methods ==

=== static public BodyDescription generateNew() ===
Creates a new body description.

Note that it must be assigned to the NPC after you finish configuring it!

== Public Methods ==

=== void setBreastSize(int breastSize) ===
Size of breasts -- uses same scale used by player class

=== int getBreastSize() ===

=== void setBreastRows(int breastRows) ===
Number of rows of breasts

=== int getBreastRows() ===

=== void setDickSize(int dickSize) ===
Size of dick -- uses same scale as player class

=== int getDickSize() ===

=== void setVaginaSize(int vaginaSize) ===
Size of vagina -- uses same scale as player class

=== int getVaginaSize() ===

=== void setDexterous(bool dexterous) ===
Does the character have dexterous hands? False if no hands, hands are bound, or non-dexterous paws

=== bool isDexterous() ===

=== bool getHasAlternateVoice() ===
If the NPC is incapable of normal human speech (also see Vocal string below).

=== void setHasAlternateVoice(bool hasAlternateVoice) ===

=== string getAlternateVocalString() ===
If NPC is incapable of normal human speech (alternate vocal bool above), then what noise do they produce instead?

=== void setAlternateVocalString(string alternateVocalString) ===

=== bool getBipedal() ===
If the NPC walks on two legs

=== void setBipedal(bool bipedal) ===

=== void setUniqueBodyPartDescription(string bodyPartName, string description) ===
Can set a description for a body part for specific flavor.

=== string getBodyPartDescription(string bodyPartName) ===
Tries to get the body part description, if one is defined. If unavailable, just returns ""

== Sample code ==
See SetOwnerWithScene sample for an example of body description in use.<syntaxhighlight lang="lua">
-- Placed in global scope so it runs on load.
bodyDescription = BodyDescription.generateNew();
bodyDescription.setBreastSize(4); -- D Cup
bodyDescription.setBreastRows(2);
bodyDescription.setDickSize(10); -- Inches
bodyDescription.setVaginaSize(2);
bodyDescription.setUniqueBodyPartDescription("HANDS", "oversized paws");
bodyDescription.setUniqueBodyPartDescription("TEETH", "fangs");
-- etc...
this.setBodyPartDescription(bodyDescription);
</syntaxhighlight>

Modding:BodyPart

2026-01-09T21:32:32Z

SkyCorp: add link to body part name list page

Represents a particular transformation the player can undergo.

== Public Static Methods ==

=== static BodyPart getBodyPart(string bodyPartName) ===
Gets body part object from body part name (string). Returns null if no body part with that name can be found.

See [[Modding:Body part name list|name list]] for valid body part names

== Public Methods ==

=== int getTransformationSeverity() ===
How transformed is this body part?
* 0=human
* 1=hideable non-human
* 2=unhideable non-human

=== void setTransformationSeverity(int severity) ===
Set how transformed this body part is.
* 0=human
* 1=hideable non-human
* 2=unhideable non-human

=== [[Species]] getSpeciesType() ===
Gets the species the body part is set as.

=== void setSpeciesType([[Species]] species) ===
Sets what species the body part is.

[[Category:LUA Class Reference]]

Modding:Body part

2026-01-09T21:31:47Z

SkyCorp: SkyCorp moved page Modding:Body part to Modding:Body part name list

#REDIRECT [[Modding:Body part name list]]

Modding:Body part name list

2026-01-09T21:31:47Z

SkyCorp: SkyCorp moved page Modding:Body part to Modding:Body part name list

This page lists body parts tracked by the game engine.

Each part can transformed by changing into a different [[TF Type]]. Each transformation can be either a first level transformation (can hide under clothes), or a second level transformation (cannot hide under clothes)

{| class="wikitable"
!Body part name
!Description
|-
|FEET
|
|-
|LEGS
|
|-
|TORSO
|Chest / upper body
|-
|ARMS
|
|-
|HANDS
|
|-
|UBACK_ATTACH
|Anything attached to the upper back. Human = nothing. Otherwise, probably is wings.
|-
|LBACK_ATTACH
|Anything attached to the lower back. Usually human/nothing, or tails. Spider's opisthosoma exists here also.
|-
|EYES
|
|-
|TEETH
|
|-
|HEAD_HAIR
|Not used yet
|-
|NOSE
|
|-
|EARS
|
|-
|MOUTH
|
|-
|UDDER
|Generally is human (does not exist), unless cow.
|-
|PENIS
|Generally is human (normal penis), even if female/zero sized penis.
|}
[[Category:Engine]]

TF Type

2026-01-09T21:29:30Z

SkyCorp: SkyCorp moved page TF Type to Modding:TF Type

#REDIRECT [[Modding:TF Type]]

Modding:TF Type

2026-01-09T21:29:30Z

SkyCorp: SkyCorp moved page TF Type to Modding:TF Type

Each type represents a particular type of creature the player can be transformed into for a given [[body part]].
{| class="wikitable"
!TF Type
!Notes
|-
|HUMAN
|Default
|-
|FOX
|
|-
|COW
|
|-
|DRAGONQUEEN
|
|-
|SLUGGIRL
|
|-
|PANDA
|
|-
|DRAGON
|
|-
|ELEPHANT
|
|-
|CAT
|
|-
|TIGER
|
|-
|HORSE
|
|-
|TURKEY
|
|-
|SPIDER
|
|}
[[Category:Engine]]

Body part

2026-01-09T21:29:02Z

SkyCorp: SkyCorp moved page Body part to Modding:Body part

#REDIRECT [[Modding:Body part]]

Modding:Body part name list

2026-01-09T21:29:02Z

SkyCorp: SkyCorp moved page Body part to Modding:Body part

Modding:Entity

2026-01-09T02:09:22Z

SkyCorp: added defaultGetName function

Entity Mod JSON Format

2026-01-09T01:47:38Z

SkyCorp: Add NameType parameter to name(...)

Entity JSON supports a variety of parameters to create custom objects.

== Fixed fields ==
A "'''type'''" of "ENTITY" should be used when creating an entity mod.

An optional "'''id'''" parameter can be used to refer to this type of entity (for instance in Entity.generate() to programmatically create additional entities). Be careful not to use the same id as another mod -- if you use the same mod name as your mod wiki page, you can be assured of no conflicts. (Introduced in r25)

An optional "'''customPublicFunctions'''" parameter is an array of custom lua functions that should be publicly available to other lua scripts. The [[Sample: Radio|radio sample]] shows an example of this. You can pass and return values, however, it's recommened to stick with primitive values when possible. Initial testing shows complex values like Tables and Entities are also okay to pass, but this is not well tested yet. (Introduced in r35)

== Dynamic fields ==
JSON definitions can specify each as programmable (LUA) or literal values.
{| class="wikitable"
!Return Type
!Parameter
|-
|string
|
=== name([[Modding:NameType|NameType]] nameType = NameType.Unspecified) ===
Title of the item.

A nametype may be parsed to differentiate which type of name is being requested (ex: a button name or dialogue name)

See also: [[Modding:Defining Names|Defining Names]]
|-
|string
|
=== description ===
Description of the item when looked at.
|-
|boolean
|
=== playerOnEnterRoom ===
Can be used to present some special text when player enters a room when this object is inside it or prevent the player from entering. But if it's not necessary to prevent player from entering, you may want to use the notify version of this function below.

Normally true. If false, will prevent mapscene from doing further room processing (be sure to use a continue scene)

As of r35, Lua function will receive these variables as parameters:

- currentRoom:String (however, currentRoom is placeholder. It can be queried for manually if needed based on entity current position)

- destinationRoom:String
|-
|boolean
|
=== playerAttemptLeaveRoom ===
Can be used to prevent player from leaving room when in same room as entity.

Normally true. If false, will prevent mapscene from doing further room processing (be sure to use a continue scene)

As of r35, Lua function will receive these variables as parameters:

- currentRoom:String (however, currentRoom is placeholder. It can be queried for manually if needed based on entity current position)

- destinationRoom:String

- destinationRoomID:int

(In r51, the internal way playerAttemptLeaveRoom() works changed to use Locations, however, the modding system has not yet been updated. If you need to use currentRoom or get map information, ask Skye to update this mod API for this function to use Locations also.)
|-
|boolean
|
=== isExaminable ===
Allow player to examine object? (This is the page description is displayed on. Otherwise will be invisible to player).
|-
|boolean
|
=== isUseable ===
Display the 'use' button on the examine item page?
|-
|boolean
|
=== doUse ===
Action to do on using entity.

Usually should return true -- this will cause a continue scene after the text.

For a manual continue or a different scene change, return false.
|-
|boolean
|
=== isPickupable ===
Should a pick-up item be displayed on item page if item is in the world?
|-
|boolean
|
=== playerAttemptPickupCheck ===
Player has opted to pick up the item (may output descriptive message to screen)

Returns if successful in pickup attempt.
|-
|boolean
|
=== isDropable ===
Should a drop item be displayed on item page if item is in inventory?
|-
|boolean
|
=== playerAttemptDropCheck ===
Player has opted to drop the item. Return if successful in drop attempt.
|-
|void
|
=== inInventoryTick ===
Called each turn the item exists in the player's inventory.
|-
|void
|
===inWorldTick===
Called each turn the item exists on the map somewhere (may not be called if player is on a different map).
|-
|void
|
===notifyPlayerEnterRoom===
Notify object that player has just entered the same room as us.

Okay to output to screen - this is called after showScene() of the room.

As of r35, Lua function will receive these variables as parameters:

- arrivingFromRoom String name of room that was arrived from (before this room)

- arrivingFromRoomID ID of room arriving from (before this room)
|-
|void
|
===notifyPlayerEnterRoomPreScene===
Notify object that player has just entered the same room as us

This variant happens BEFORE showScene() is called, so is best for when entities are moving in/out based on player actions.

Don't output to screen using this call - it will be eaten by showScene()

As of r35, Lua function will receive these variables as parameters:

- arrivingFromRoom String name of room that was arrived from (before this room)

- arrivingFromRoomID ID of room arriving from (before this room)

|-
|void
|
===notifyPlayerLeftRoom===
Notify entity of the room the player is leaving that the player left successfully. Entities should not write to the screen since showScene() will immediately overwrite it.

The player's position has already been updated with the correct location by this point.

As of r35, Lua function will receive these variables as parameters:

- originalRoomName

- originalRoomID
|-
|string
|
===personalName()===
A name of them as a person (eg: 'Micky') as opposed to the general name above. This name would be used as the character refers to themselves. Ie, 'I am Micky' as opposed to 'I am Cowgirl Micky'. If you set this, normally the name field would be something more generic, like their species.

Normally when you first encounter an enemy, it just shows their generic type (ex: "AlphaSlug") as their button (UI Name), which is what the main name field is. Their dialogue might use their name (the "GameText" name, which pulls from this personalName field), and if they become your owner, their UI name likely becomes something like "<Honorific> <Personal Name>"

Note, if you set this (or usesRandomizedName() below), it is recommended to not set the overall name function. To set species/initial UI name, you can set the 'name' field in 'initialValues' instead of the 'name' function override.

See also: [[Modding:Defining Names|Defining Names]]

Introduced in r56.1
|-
|bool
|
===usesRandomizedName()===
If true, a randomized name will be assigned to this entity. The name will be a common one related to the assigned pronouns of the entity. (Mostly makes sense for NPCs)

Introduced in r56.1
|-
|string
|
===desiredPlayerSubmissiveType()===
Can define this if the npc is a dom to tell game text what sorts of sub types to use for its variables. Basically, what sort of dom/sub relationship will the npc form with the player, if the player accepts them as their owner?

Currently, the following sub types are supported:
*Sub (Default)
*Breeder
*Pet
*Slave

Any other string other than the above is currently not supported.

Introduced in r56.1
|-
|string
|
===pronoun()===
If an NPC, can set this to the character's pronouns so gametext variables can refer to them properly.

Currently, the following pronoun types are supported:
*Unspecified (default)
*He
*She
*Shi
*It
*They

Any other string other than the above is currently not supported.

Introduced in r56.1
|}

Entity Mod JSON Format

2026-01-09T01:43:05Z

SkyCorp: Cross reference Defining Names page

Entity JSON supports a variety of parameters to create custom objects.

== Fixed fields ==
A "'''type'''" of "ENTITY" should be used when creating an entity mod.

An optional "'''id'''" parameter can be used to refer to this type of entity (for instance in Entity.generate() to programmatically create additional entities). Be careful not to use the same id as another mod -- if you use the same mod name as your mod wiki page, you can be assured of no conflicts. (Introduced in r25)

An optional "'''customPublicFunctions'''" parameter is an array of custom lua functions that should be publicly available to other lua scripts. The [[Sample: Radio|radio sample]] shows an example of this. You can pass and return values, however, it's recommened to stick with primitive values when possible. Initial testing shows complex values like Tables and Entities are also okay to pass, but this is not well tested yet. (Introduced in r35)

== Dynamic fields ==
JSON definitions can specify each as programmable (LUA) or literal values.
{| class="wikitable"
!Return Type
!Parameter
|-
|string
|
=== name ===
Title of the item.

See also: [[Modding:Defining Names|Defining Names]]
|-
|string
|
=== description ===
Description of the item when looked at.
|-
|boolean
|
=== playerOnEnterRoom ===
Can be used to present some special text when player enters a room when this object is inside it or prevent the player from entering. But if it's not necessary to prevent player from entering, you may want to use the notify version of this function below.

Normally true. If false, will prevent mapscene from doing further room processing (be sure to use a continue scene)

As of r35, Lua function will receive these variables as parameters:

- currentRoom:String (however, currentRoom is placeholder. It can be queried for manually if needed based on entity current position)

- destinationRoom:String
|-
|boolean
|
=== playerAttemptLeaveRoom ===
Can be used to prevent player from leaving room when in same room as entity.

Normally true. If false, will prevent mapscene from doing further room processing (be sure to use a continue scene)

As of r35, Lua function will receive these variables as parameters:

- currentRoom:String (however, currentRoom is placeholder. It can be queried for manually if needed based on entity current position)

- destinationRoom:String

- destinationRoomID:int

(In r51, the internal way playerAttemptLeaveRoom() works changed to use Locations, however, the modding system has not yet been updated. If you need to use currentRoom or get map information, ask Skye to update this mod API for this function to use Locations also.)
|-
|boolean
|
=== isExaminable ===
Allow player to examine object? (This is the page description is displayed on. Otherwise will be invisible to player).
|-
|boolean
|
=== isUseable ===
Display the 'use' button on the examine item page?
|-
|boolean
|
=== doUse ===
Action to do on using entity.

Usually should return true -- this will cause a continue scene after the text.

For a manual continue or a different scene change, return false.
|-
|boolean
|
=== isPickupable ===
Should a pick-up item be displayed on item page if item is in the world?
|-
|boolean
|
=== playerAttemptPickupCheck ===
Player has opted to pick up the item (may output descriptive message to screen)

Returns if successful in pickup attempt.
|-
|boolean
|
=== isDropable ===
Should a drop item be displayed on item page if item is in inventory?
|-
|boolean
|
=== playerAttemptDropCheck ===
Player has opted to drop the item. Return if successful in drop attempt.
|-
|void
|
=== inInventoryTick ===
Called each turn the item exists in the player's inventory.
|-
|void
|
===inWorldTick===
Called each turn the item exists on the map somewhere (may not be called if player is on a different map).
|-
|void
|
===notifyPlayerEnterRoom===
Notify object that player has just entered the same room as us.

Okay to output to screen - this is called after showScene() of the room.

As of r35, Lua function will receive these variables as parameters:

- arrivingFromRoom String name of room that was arrived from (before this room)

- arrivingFromRoomID ID of room arriving from (before this room)
|-
|void
|
===notifyPlayerEnterRoomPreScene===
Notify object that player has just entered the same room as us

This variant happens BEFORE showScene() is called, so is best for when entities are moving in/out based on player actions.

Don't output to screen using this call - it will be eaten by showScene()

As of r35, Lua function will receive these variables as parameters:

- arrivingFromRoom String name of room that was arrived from (before this room)

- arrivingFromRoomID ID of room arriving from (before this room)

|-
|void
|
===notifyPlayerLeftRoom===
Notify entity of the room the player is leaving that the player left successfully. Entities should not write to the screen since showScene() will immediately overwrite it.

The player's position has already been updated with the correct location by this point.

As of r35, Lua function will receive these variables as parameters:

- originalRoomName

- originalRoomID
|-
|string
|
===personalName()===
A name of them as a person (eg: 'Micky') as opposed to the general name above. This name would be used as the character refers to themselves. Ie, 'I am Micky' as opposed to 'I am Cowgirl Micky'. If you set this, normally the name field would be something more generic, like their species.

Normally when you first encounter an enemy, it just shows their generic type (ex: "AlphaSlug") as their button (UI Name), which is what the main name field is. Their dialogue might use their name (the "GameText" name, which pulls from this personalName field), and if they become your owner, their UI name likely becomes something like "<Honorific> <Personal Name>"

Note, if you set this (or usesRandomizedName() below), it is recommended to not set the overall name function. To set species/initial UI name, you can set the 'name' field in 'initialValues' instead of the 'name' function override.

See also: [[Modding:Defining Names|Defining Names]]

Introduced in r56.1
|-
|bool
|
===usesRandomizedName()===
If true, a randomized name will be assigned to this entity. The name will be a common one related to the assigned pronouns of the entity. (Mostly makes sense for NPCs)

Introduced in r56.1
|-
|string
|
===desiredPlayerSubmissiveType()===
Can define this if the npc is a dom to tell game text what sorts of sub types to use for its variables. Basically, what sort of dom/sub relationship will the npc form with the player, if the player accepts them as their owner?

Currently, the following sub types are supported:
*Sub (Default)
*Breeder
*Pet
*Slave

Any other string other than the above is currently not supported.

Introduced in r56.1
|-
|string
|
===pronoun()===
If an NPC, can set this to the character's pronouns so gametext variables can refer to them properly.

Currently, the following pronoun types are supported:
*Unspecified (default)
*He
*She
*Shi
*It
*They

Any other string other than the above is currently not supported.

Introduced in r56.1
|}

Modding:Defining Names

2026-01-09T01:41:40Z

SkyCorp: LUA example for Custom (Entity or Adv. Monster)

This page will detail some general information about how names are defined for mods.

Most situations will fit into one of the following patterns:

== Simple Monster Mod - Static Name ==
A simple monster mod (no code) who always has the same name can do something like this:<syntaxhighlight lang="json">
{
...,
"name": "Harpy"
},
...
}
</syntaxhighlight>See [https://skycorp.global/skyscript/mods/v/6/male-spider Spider] or [https://sclab.skycorp.global/ SCLab] for examples.

== Entities - Static Name ==
Physical objects (ex: a painting) probably just need a single name, in which case they will not define a dynamic function and just use use the 'literalString' functionality. <syntaxhighlight lang="json">
{
...,
"name":
{
"literalString": "Fox Painting"
},
...
}
</syntaxhighlight>Example: [https://skycorp.global/skyscript/mods/v/27/sample-radio Radio]

== Advanced Monsters - Static Name ==
Most monsters don't change names. In this case, it is fine to use the 'initialValues' to set their base name. This has the advantage that when the UI name changes, the existing logic will handle this because name is not being overridden. For instance, when the monster sleeps, or becomes your owner. Example:<syntaxhighlight lang="json">
{
...,
"initialValues":
{
"name": "Wyvern",
...
},
...
}
</syntaxhighlight>Example: [https://skycorp.global/skyscript/mods/v/45/wyvern-shemale Wyvern Shemale]

== Advanced Monsters - Personal Name ==
You may want to have a monster appear to be generic at first, but use a [[Entity Mod JSON Format#personalName()|personal name]] once they become the player's owner or in gametext. In this case, you can use the personal name feature:<syntaxhighlight lang="json">
{
...,
"initialValues":
{
"name": "Fox",
...
},
"personalName": {
"literalString": "Tina"
},
"pronoun": {
"literalString": "she"
},
}
</syntaxhighlight>

== Advanced Monsters - Random Name ==
You may want to have many monsters of a specific type (ex: Fox), but each of those monsters have their own individual random name (ex: Veronica, Amy, etc). In this case, you can use the random name feature:<syntaxhighlight lang="json">
{
...,
"initialValues":
{
"name": "Fox",
...
},
"usesRandomizedName": {
"literalBoolean": true
},
"pronoun": {
"literalString": "she"
},
}
</syntaxhighlight>[[Entity Mod JSON Format#pronoun()|Pronoun]] is also set so that the correct name gender will be pulled from the random list.

Example: SetOwnerWithScene

== Custom (Entity or Adv. Monster) ==
You can also completely override how name is shown and displayed by implementing <code>name([[Modding:NameType|nameType]])</code><syntaxhighlight lang="lua">
function name(nameType)
if nameType == NameType.UI then
return "Blep-Button";
end

if nameType == NameType.GameText then
return "Blep-Personal";
end

return "Blep-General";
-- For testing purposes only. In a real situation, the
-- UI and Unspecified types should usually be the same thing.
-- Ex: UI&Unspecified is "Fox" and GameText is "Veronica"
end
</syntaxhighlight>More practically, for advanced monsters, you could also set the name normally, and when needed, override it in certain circumstances, ex:<syntaxhighlight lang="lua">
function name(nameType)
if blepping == true then
return "Blepper";
end

return this.defaultGetName(nameType);
end
</syntaxhighlight>Most mods won't need to override the name function like this though to accomplish normal game behavior.