Class HomeSystem

Statichome_format_version

StaticmaxHomesPerPlayer

• get maxHomesPerPlayer(): number

  The maximum number of homes per player.

  Dynamic Property ID: homeSystemSettings:maxHomesPerPlayer

  Returns number

  Default

  Infinity
  Copy

• set maxHomesPerPlayer(maxHomes: number): void

  Parameters

  • maxHomes: number

  Returns void

StaticgetAllHomes

• getAllHomes(): Globals.modules.cmds.Home[]

  Gets all homes.

  Returns Globals.modules.cmds.Home[]

  A list of all homes.

StaticgetHomeIds

• getHomeIds(): string[]

  Gets all home IDs.

  Returns string[]

  A list of all home IDs.

StaticgetHomeIdsForPlayer

• getHomeIdsForPlayer(
      player: string | Player | extendedExecuteCommandPlayerW,
  ): string[]

  Gets the home IDs for the given player.

  Parameters

  • player: string | Player | extendedExecuteCommandPlayerW

    The player to get the home IDs for. Can be a player object, or a player ID.

  Returns string[]

  A list of home IDs for the given player.

StaticgetHomes

• getHomes(homeIds: string[]): Globals.modules.cmds.Home[]

  Gets the homes for the given home IDs.

  Parameters

  • homeIds: string[]

    The list of home IDs to get the homes for.

  Returns Globals.modules.cmds.Home[]

  The homes for the given home IDs.

StaticgetHomesForPlayer

• getHomesForPlayer(
      player: string | Player | extendedExecuteCommandPlayerW,
  ): Globals.modules.cmds.Home[]

  Gets the homes for the given player.

  Parameters

  • player: string | Player | extendedExecuteCommandPlayerW

    The player to get the homes for. Can be a player object, or a player ID.

  Returns Globals.modules.cmds.Home[]

  A list of homes for the given player.

StatictestIfPlayerAtMaxHomes

• testIfPlayerAtMaxHomes(
      player: string | Player | extendedExecuteCommandPlayerW,
  ): boolean

  Checks if the given player has reached the maximum number of homes.

  Parameters

  • player: string | Player | extendedExecuteCommandPlayerW

    The player to check.

  Returns boolean

  True if the player has reached the maximum number of homes, false otherwise.