Entity Mod JSON Format - Revision history

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

2026-02-25T01:47:43Z

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

← Older revision		Revision as of 01:47, 25 February 2026
Line 7:		Line 7:

	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)		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 ==		== Dynamic fields ==

SkyCorp at 02:47, 22 January 2026

2026-01-22T02:47:10Z

← Older revision		Revision as of 02:47, 22 January 2026
Line 73:		Line 73:
	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.		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).		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).		* 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.		* dynamicOptions can be modified via its function call to add new options.

SkyCorp: Fix formatting

2026-01-22T02:45:46Z

Fix formatting

← Older revision		Revision as of 02:45, 22 January 2026
Line 73:		Line 73:
	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.		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).		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).		* 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.		* 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]		Sample: [https://skycorp.global/skyscript/mods/v/92/sample-entity-with-extra-look-buttons Entity with extra look options]

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

2026-01-22T02:44:17Z

addEntityLookOptions(DynamicOptions dynamicOptions, Scene returnScene)

← Older revision		Revision as of 02:44, 22 January 2026
Line 73:		Line 73:
	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.		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).		Usually you would want to call `this.defaultAddEntityLookOptions(dynamicOptions, returnScene);` to also include the normal buttons (pick up, back, etc).
	dynamicOptions can be modified via its function call to add new options.
			- 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]		Sample: [https://skycorp.global/skyscript/mods/v/92/sample-entity-with-extra-look-buttons Entity with extra look options]
Line 82:		Line 84:
	\|boolean		\|boolean
	\|		\|

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

SkyCorp: Fix formatting

2026-01-22T02:43:01Z

Fix formatting

← Older revision		Revision as of 02:43, 22 January 2026
Line 72:		Line 72:
	=== addEntityLookOptions([[Modding:DynamicOptions\|DynamicOptions]] dynamicOptions, [[Modding:Scene\|Scene]] returnScene) ===		=== 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.		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).		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.		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]		Sample: [https://skycorp.global/skyscript/mods/v/92/sample-entity-with-extra-look-buttons Entity with extra look options]

			Added in r56.1
	\|-		\|-
	\|boolean		\|boolean

SkyCorp: New Dynamic field: addEntityLookOptions

2026-01-22T02:42:03Z

New Dynamic field: addEntityLookOptions

← Older revision		Revision as of 02:42, 22 January 2026
Line 67:		Line 67:
	=== isUseable ===		=== isUseable ===
	Display the 'use' button on the examine item page?		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		\|boolean

SkyCorp: Add NameType parameter to name(...)

2026-01-09T01:47:38Z

Add NameType parameter to name(...)

← Older revision		Revision as of 01:47, 9 January 2026
Line 16:		Line 16:
	\|string		\|string
	\|		\|
	=== name ===		=== name([[Modding:NameType\|NameType]] nameType = NameType.Unspecified) ===
	Title of the item.		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]]		See also: [[Modding:Defining Names\|Defining Names]]

SkyCorp: Cross reference Defining Names page

2026-01-09T01:43:05Z

Cross reference Defining Names page

← Older revision		Revision as of 01:43, 9 January 2026
Line 18:		Line 18:
	=== name ===		=== name ===
	Title of the item.		Title of the item.

			See also: [[Modding:Defining Names\|Defining Names]]
	\|-		\|-
	\|string		\|string
Line 155:		Line 157:

	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.		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		Introduced in r56.1

SkyCorp: formatting

2026-01-09T01:03:20Z

formatting

Show changes

SkyCorp: pronoun()

2026-01-08T02:23:17Z

pronoun()

@@ Line 157: / Line 157: @@
 * Pet
 * Slave
 Any other string other than the above is currently not supported.