Modding:GameText - Revision history

SkyCorp: More parameters for parseText(...)

2026-01-15T22:40:04Z

More parameters for parseText(...)

← Older revision		Revision as of 22:40, 15 January 2026
Line 12:		Line 12:
	== Public Static Methods ==		== Public Static Methods ==

	=== static string parseText(string unparsedText) ===		=== static string parseText(string unparsedText, string parameter="UnknownParameter", [[Modding:Entity\|Entity]] npc=null) ===
	Parses text and returns the result. See ''[[Text Variables]]''.		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) ===		=== static boolean hasText(string textKey) ===

SkyCorp: Remove bit about using text variable names the same as wiki pages name since it's no longer relevant now that there's mod database

2025-12-31T02:31:41Z

Remove bit about using text variable names the same as wiki pages name since it's no longer relevant now that there's mod database

← Older revision		Revision as of 02:31, 31 December 2025
Line 9:		Line 9:
	Generally, Game Text values should not include a trailing paragraph (\n\n) as that is added via the withParagraph parameter.		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~~. If you use the same mod name as your mod wiki page, you can be assured of no conflicts~~.		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 ==		== Public Static Methods ==

SkyCorp: SkyCorp moved page GameText to Modding:GameText

2025-06-17T07:28:07Z

SkyCorp moved page GameText to Modding:GameText

← Older revision

Revision as of 07:28, 17 June 2025

SkyCorp at 21:36, 29 December 2017

2017-12-29T21:36:58Z

← Older revision		Revision as of 21:36, 29 December 2017
Line 7:		Line 7:
	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		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. If you use the same mod name as your mod wiki page, you can be assured of no conflicts.
	== Public Static Methods ==		== Public Static Methods ==

			=== static string parseText(string unparsedText) ===
			Parses text and returns the result. See ''[[Text Variables]]''.

	=== static boolean hasText(string textKey) ===		=== static boolean hasText(string textKey) ===
	~~Returns~~		Does specified text key exist in any loaded dictionary?

	~~=== static void printText(string textKey ===~~

	=== static ~~string getText~~(string textKey ===		=== 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 ~~getTextRaw~~(string textKey ===		=== static string getText(string textKey, [boolean withParagraph=true]) ===
			Gets parsed text from either game text or game text private

	=== static ~~void setTextOverride~~(string textKey ===		=== 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]]		[[Category:LUA Class Reference]]

SkyCorp at 21:21, 29 December 2017

2017-12-29T21:21:06Z

← Older revision		Revision as of 21:21, 29 December 2017
Line 1:		Line 1:
			[[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.		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		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
	~~[[File:TextEditorScreenshot.png\|thumb\|~~
	~~An example of text key/value pairs from the text editor.~~
	]]

	== Public Static Methods ==		== Public Static Methods ==

SkyCorp at 21:20, 29 December 2017

2017-12-29T21:20:55Z

← Older revision		Revision as of 21:20, 29 December 2017
Line 2:		Line 2:

	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		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
			[[File:TextEditorScreenshot.png\|thumb\|
			An example of text key/value pairs from the text editor.
			]]

	== Public Static Methods ==		== Public Static Methods ==

SkyCorp at 21:19, 29 December 2017

2017-12-29T21:19:14Z

← Older revision		Revision as of 21:19, 29 December 2017
Line 1:		Line 1:
	~~== Public Static Methods ==~~		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.

	~~=== static Map getMap(string mapName) ===~~		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
	~~Gets map object from map name (~~string). ~~Returns null if map~~ with ~~that name can not be found.~~

	== Public Methods ==		== Public Static 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~~)		=== static boolean hasText(string textKey) ===
			Returns

	~~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.~~		=== static void printText(string textKey ===

	~~Parameters:~~		=== static string getText(string textKey ===
	* 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)~~ ===		=== static string getTextRaw(string textKey ===
	~~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)~~ ===		=== static void setTextOverride(string textKey ===
	~~Which room is a particular entity in? If not found, then 0~~

	~~=== string getName() ===~~
	~~Name of the map~~
	[[Category:LUA Class Reference]]		[[Category:LUA Class Reference]]

SkyCorp: Created page with "== 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. == Publi..."

2017-12-29T21:12:12Z

Created page with "== 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. == Publi..."

New page

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