Entity Mod JSON Format

Entity JSON supports a variety of parameters to create custom objects.

Fixed fields

A "type" of "ENTITY" should be used when creating an entity mod.

An optional "id" parameter can be used to refer to this type of entity (for instance in Entity.generate() to programmatically create additional entities). Be careful not to use the same id as another mod -- if you use the same mod name as your mod wiki page, you can be assured of no conflicts. (Introduced in r25)

Dynamic fields

JSON definitions can specify each as programmable (LUA) or literal values.

Return Type	Parameter
string	name Title of the item.
string	description Description of the item when looked at.
boolean	playerOnEnterRoom Can be used to present some special text when player enters a room when this object is inside it. Normally true. If false, will prevent mapscene from doing further room processing (be sure to use a continue scene)
boolean	playerAttemptLeaveRoom Can be used to prevent player from leaving room when in same room as entity. Normally true. If false, will prevent mapscene from doing further room processing (be sure to use a continue scene)
boolean	isExaminable Allow player to examine object?  (This is the page description is displayed on. Otherwise will be invisible to player).
boolean	isUseable Display the 'use' button on the examine item page?
boolean	doUse Action to do on using entity. Usually should return true -- this will cause a continue scene after the text. For a manual continue or a different scene change, return false.
boolean	isPickupable Should a pick-up item be displayed on item page if item is in the world?
boolean	playerAttemptPickupCheck Player has opted to pick up the item (may output descriptive message to screen) Returns if successful in pickup attempt.
boolean	isDropable Should a drop item be displayed on item page if item is in inventory?
boolean	playerAttemptDropCheck Player has opted to drop the item. Return if successful in drop attempt.
void	inInventoryTick Called each turn the item exists in the player's inventory.
void	inWorldTick Called each turn the item exists on the map somewhere (may not be called if player is on a different map).
void	(TODO) notifyPlayerEnterRoom
void	(TODO) notifyPlayerEnterRoomPreScene
void	(TODO) notifyPlayerLeftRoom