Modding:Defining Names - Revision history

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

2026-02-25T01:52:55Z

Document how to use initial values name for entity mods

@@ Line 24: / Line 24: @@
+}
 </syntaxhighlight>Example:  [https://skycorp.global/skyscript/mods/v/27/sample-radio Radio]
 == Advanced Monsters - Static Name ==

SkyCorp: LUA example for Custom (Entity or Adv. Monster)

2026-01-09T01:41:40Z

LUA example for Custom (Entity or Adv. Monster)

← Older revision		Revision as of 01:41, 9 January 2026
Line 92:		Line 92:
	-- Ex: UI&Unspecified is "Fox" and GameText is "Veronica"		-- Ex: UI&Unspecified is "Fox" and GameText is "Veronica"
	end		end
	</syntaxhighlight>More practically, you could also ~~sometimes~~ set the name, ~~but otherwise fall through to do special modes only~~ in certain circumstances, ex:<syntaxhighlight lang="lua">		</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">
	~~WIP~~		function name(nameType)
	</syntaxhighlight>		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.

SkyCorp: WIP on name type guide

2026-01-09T01:34:52Z

WIP on name type guide

New page

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, you could also sometimes set the name, but otherwise fall through to do special modes only in certain circumstances, ex:<syntaxhighlight lang="lua">
WIP
</syntaxhighlight>