Modding:Entity - Revision history

SkyCorp: Added setEntityName / setPersonalName

2026-02-27T08:53:16Z

Added setEntityName / setPersonalName

← Older revision		Revision as of 08:53, 27 February 2026
Line 70:		Line 70:

	== Private Methods ==		== 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) ===		=== setBodyDescription([[Modding:BodyDescription\|BodyDescription]] bodyDescription) ===

2026-01-29T00:54:30Z

add return type

← Older revision		Revision as of 00:54, 29 January 2026
Line 44:		Line 44:
	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.		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) ===		=== void moveEntityAdjacent([[Modding:CardinalDirection\|CardinalDirection]] cardinalDirection, bool quiet = false) ===
	Moves the entity to the adjacent room.Moves entity to new location.		Moves the entity to the adjacent room.Moves entity to new location.

2026-01-28T02:50:31Z

Expose Entity.moveEntityAdjacent(...)

← Older revision		Revision as of 02:50, 28 January 2026
Line 43:		Line 43:
	=== void moveEntity(string newMapName:String, int newRoomID) ===		=== 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.		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() ===		=== void moveEntityToSameRoomAsPlayer() ===

2026-01-22T02:53:07Z

Added defaultAddEntityLookOptions

← Older revision		Revision as of 02:53, 22 January 2026
Line 74:		Line 74:
	==== string defaultGetName([[Modding:NameType\|NameType]] nameType = NameType.Unspecified) ====		==== 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.)		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]]		[[Category:LUA Class Reference]]

2026-01-09T22:56:18Z

Add get/set body description functions

← Older revision		Revision as of 22:56, 9 January 2026
Line 56:		Line 56:
	=== boolean getCursed() ===		=== boolean getCursed() ===
	Is this entity cursed?		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 ==		== Private Methods ==

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

			Added in r56.1

	=== Default versions of functions ===		=== Default versions of functions ===

2026-01-09T02:09:22Z

added defaultGetName function

@@ Line 56: / Line 56: @@
 === boolean getCursed() ===
 Is this entity cursed?
 [[Category:LUA Class Reference]]

2025-06-17T07:22:56Z

SkyCorp moved page Entity to Modding:Entity

← Older revision

Revision as of 07:22, 17 June 2025

2017-12-30T04:11:13Z

void makeCursed()

← Older revision		Revision as of 04:11, 30 December 2017
Line 51:		Line 51:

	Generally this would be called on start-up. Curse status can be modified by NPCs that can perform purification.		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() ===		=== boolean getCursed() ===
	Is this entity cursed?		Is this entity cursed?
	[[Category:LUA Class Reference]]		[[Category:LUA Class Reference]]

2017-12-30T03:39:26Z

void makeCursed()

← Older revision		Revision as of 03:39, 30 December 2017
Line 48:		Line 48:

	=== void makeCursed() ===		=== void makeCursed() ===
	Marks this entity as cursed. ~~The default drop code will prevent the item from being removed unless purified~~. ~~Intended to~~ be called on start-up.		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.

			=== boolean getCursed() ===
			Is this entity cursed?
	[[Category:LUA Class Reference]]		[[Category:LUA Class Reference]]

2017-12-30T03:31:38Z

← Older revision		Revision as of 03:31, 30 December 2017
Line 46:		Line 46:
	=== void moveEntityToSameRoomAsPlayer() ===		=== void moveEntityToSameRoomAsPlayer() ===
	Move entity from wherever it is (including inventory) into the same room as the player is in.		Move entity from wherever it is (including inventory) into the same room as the player is in.

			=== void makeCursed() ===
			Marks this entity as cursed. The default drop code will prevent the item from being removed unless purified. Intended to be called on start-up.
	[[Category:LUA Class Reference]]		[[Category:LUA Class Reference]]