01客户端导出
| 导出 | 说明 |
|---|---|
IsInsideHouse() | 玩家在房屋内时返回 true。 |
GetCurrentHouse() | 玩家当前所在的房屋，没有则为 nil。 |
LeaveHouse() | 让玩家从入口回到室外。 |
GetHouseAtPoint(coords) | 地产边界包含此地面的第一栋房屋。 |
GetHousesAtPoint(coords) | 包含此地面的所有房屋，适用于公寓楼这类重叠地块。 |
GetCurrentProperty() | 玩家当前所站的地块，没有则为 nil。 |
IsOnProperty(houseId) | 玩家是否站在该房屋的地产范围内。 |
GetHouseZone(houseId) | 房屋已保存的边界形状。 |
GetAccent() | 玩家在 Housing > 设置中选择的强调色。 |
GetAppUrl(theme) | Housing 应用页面的地址，用于将该应用添加到其他任何手机上。传入 'light' 或 'dark' 可强制使用某个主题。 |
GetAppData() | Housing 应用显示的所有内容：玩家拥有、租住或持有钥匙的房屋。 |
AppAction(action, houseId) | 对某栋房屋执行一个应用操作：'waypoint'、'lock' 或 'cams'。 |
02服务端导出
| 导出 | 说明 |
|---|---|
GetHouses() | 服务器上的所有房屋，以 id 为键。 |
GetPlayerHouses(source) | 该玩家拥有的房屋。 |
HasHouseAccess(source, houseId) | 该玩家是否拥有这栋房屋或持有其钥匙。 |
GetHouseAtPoint(coords) | 地产边界包含此地面的第一栋房屋。 |
GetHousesAtPoint(coords) | 包含此地面的所有房屋，适用于重叠地块。 |
GetHouseZone(houseId) | 房屋已保存的边界形状。 |
03事件
| 名称 | 端 | 说明 |
|---|---|---|
agency-housing:client:enteredZone | 客户端 | 玩家踏入地产范围时触发，参数为 (houseId, house)，职业或抢劫脚本无需轮询。 |
agency-housing:client:leftZone | 客户端 | 玩家离开地产范围时触发，参数为 (houseId, house)。 |
agency-housing:garage:open | 客户端 | 当使用房屋车库且 Config.Garage.script 为 'event' 时，以 (houseId, houseName) 触发，以便你自己的车库脚本打开它。 |