home_manager

Manage player homes with permissions and cooldowns — misc entry.

Entry Information

Property	Value
Entry ID	home_manager
Type	Misc
Color	Orange
Icon	mdi:home

Fields

Field	Type	Description
artifact	Ref<HomeArtifactDefinition>	Linked artifact_home entry that stores the player homes
defaultHomes	Int	Default number of homes for players without special permissions
permissionLimits	List<PermissionLimit>	Permission based limits that override the default home amount
teleportCooldownSeconds	Long	Cooldown in seconds between home teleports
homeCommand	String	Command used to teleport to a home
setHomeCommand	String	Command used to set or overwrite a home
deleteHomeCommand	String	Command used to delete a home
listHomeCommand	String	Command used to list homes
basePermission	String?	Permission required to use home commands
homeSavedMessage	String	Message shown when a home is saved
teleportMessage	String	Message shown when teleporting to a home
cooldownMessage	String	Message shown when teleport is on cooldown
limitMessage	String	Message shown when a player exceeds their home limit
removedMessage	String	Message shown when a home is removed
missingHomeMessage	String	Message shown when a player attempts to use a missing home
storageUnavailableMessage	String	Message shown when the home storage artifact is unavailable
listHeader	String	Header used when listing homes
listEntry	String	Format used for each home entry in the list
homesMenu	HomesMenuConfig	Configuration of the homes inventory menu
homeEditorMenu	HomeEditorMenuConfig	Configuration of the home editor menu
renamePromptMessage	String	Message shown when a player is asked to provide a new home name
renameCancelledMessage	String	Message shown when a player cancels the rename flow
renameSuccessMessage	String	Message shown when a home is successfully renamed
renameConflictMessage	String	Message shown when renaming a home fails because the name already exists
renameInvalidMessage	String	Message shown when the provided home name is invalid
iconUpdatedMessage	String	Message shown when the home icon has been updated
iconResetMessage	String	Message shown when the home icon is reset to the default
iconMissingItemMessage	String	Message shown when the player must hold an item to update the icon
wikiPlaceholder	String	Value returned by the placeholder %tinyessentials_homes_wiki%

Usage Example

- entry: home_manager
  name: "Manage player homes with permissions and cooldowns"
  artifact: ""
  defaultHomes: 0
  permissionLimits: []
  teleportCooldownSeconds: 0
  homeCommand: ""
  setHomeCommand: ""
  deleteHomeCommand: ""
  listHomeCommand: ""
  basePermission: ""
  homeSavedMessage: ""
  teleportMessage: ""
  cooldownMessage: ""
  limitMessage: ""
  removedMessage: ""
  missingHomeMessage: ""
  storageUnavailableMessage: ""
  listHeader: ""
  listEntry: ""
  homesMenu: ""
  homeEditorMenu: ""
  renamePromptMessage: ""
  renameCancelledMessage: ""
  renameSuccessMessage: ""
  renameConflictMessage: ""
  renameInvalidMessage: ""
  iconUpdatedMessage: ""
  iconResetMessage: ""
  iconMissingItemMessage: ""
  wikiPlaceholder: ""