Modding:Map - Revision history

SkyCorp: Bunch of new map functions!

2026-01-29T02:56:02Z

Bunch of new map functions!

← Older revision		Revision as of 02:56, 29 January 2026
Line 52:		Line 52:

	(Introduced in r26)		(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]]		[[Category:LUA Class Reference]]

SkyCorp: SkyCorp moved page Map (Class) to Modding:Map

2025-06-17T07:28:59Z

SkyCorp moved page Map (Class) to Modding:Map

← Older revision

Revision as of 07:28, 17 June 2025

SkyCorp: /* Location createLocation(int roomID) */

2018-03-06T04:47:49Z

Location createLocation(int roomID)

← Older revision		Revision as of 04:47, 6 March 2018
Line 50:		Line 50:
	=== [[Location]] createLocation(int roomID) ===		=== [[Location]] createLocation(int roomID) ===
	Returns the Location for a particular roomID on this map. Does not check the room ID actually exists.		Returns the Location for a particular roomID on this map. Does not check the room ID actually exists.

	(Introduced in r26)		(Introduced in r26)
	[[Category:LUA Class Reference]]		[[Category:LUA Class Reference]]

SkyCorp at 04:47, 6 March 2018

2018-03-06T04:47:31Z

← Older revision		Revision as of 04:47, 6 March 2018
Line 47:		Line 47:
	=== string getName() ===		=== string getName() ===
	Name of the map		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)
	[[Category:LUA Class Reference]]		[[Category:LUA Class Reference]]

SkyCorp at 21:11, 29 December 2017

2017-12-29T21:11:01Z

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

SkyCorp at 05:29, 29 December 2017

2017-12-29T05:29:50Z

← Older revision		Revision as of 05:29, 29 December 2017
Line 2:		Line 2:
	== Public Methods ==		== Public Methods ==

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

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

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

Line 17:		Line 17:
	Gets name of room. If no such room, returns "INVALID ROOM"		Gets name of room. If no such room, returns "INVALID ROOM"

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

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

Line 38:		Line 38:
	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.		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) ===		=== int getRoomIDOfEntity([[Entity]] entity) ===
	Which room is a particular entity in? If not found, then 0		Which room is a particular entity in? If not found, then 0

SkyCorp at 05:28, 29 December 2017

2017-12-29T05:28:33Z

← Older revision		Revision as of 05:28, 29 December 2017
Line 2:		Line 2:
	== Public Methods ==		== Public Methods ==

	~~luaMap~~.~~addItem~~		=== boolean addItem(Entity entity, int roomID) ===
			Attempt adding entity to roomID.

	~~deleteItem~~		More performant to use entity's

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

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

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

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

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

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

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

SkyCorp at 05:16, 29 December 2017

2017-12-29T05:16:28Z

@@ Line 1: / Line 1: @@
 == Public Methods ==
-luaMap.addItem = facade.addItem;
+luaMap.addItem
-=== int roomID ===
+getNamedEntityInRoom
 [[Category:LUA Class Reference]]

SkyCorp: Created page with "A location is a combination of a roomID (int), and a particular Map. == Public Methods == luaMap.addItem = facade.addItem; luaMap.deleteItem = facade.deleteItem; luaMa..."

2017-12-29T05:15:41Z

Created page with "A location is a combination of a roomID (int), and a particular Map. == Public Methods == luaMap.addItem = facade.addItem; luaMap.deleteItem = facade.deleteItem; luaMa..."

New page

A location is a combination of a roomID (int), and a particular Map.

== Public Methods ==

luaMap.addItem = facade.addItem;
luaMap.deleteItem = facade.deleteItem;
luaMap.getRoomName = facade.getRoomName;
luaMap.getNamedEntityInRoom = facade.getNamedEntityInRoom;
//luaMap.getEntityInRoomByType = facade.getEntityInRoomByType;
luaMap.setTagBoolean = facade.setTagBoolean;
luaMap.getTagBoolean = facade.getTagBoolean;
luaMap.getRoomIDOfEntity = facade.getRoomIDOfEntity;
luaMap.getName = facade.getName;

=== int roomID ===

=== [[Map (Class)|Map]] getMap() ===
[[Category:LUA Class Reference]]