36 Commits

Author SHA1 Message Date
644f6795a6 Release v1.3.2 2022-01-17 11:41:12 +01:00
31bc7c82e5 Add german translation 2022-01-17 11:38:56 +01:00
7fd6f1f9a9 Make locked door alert messages localizable (fixes #15) 2022-01-17 11:29:52 +01:00
Brother Sharp
d51c416ac2 add japanese localization 2022-01-17 11:16:11 +01:00
697950e22a Release v1.3.1 2022-01-05 21:15:12 +01:00
78d41d2a40 Don't suppress other key events in the toggleSecretDoors keybinding (fixes #12) 2022-01-05 21:12:52 +01:00
c222d3019c Release v1.3.0 2022-01-05 12:02:14 +01:00
a2541bf934 Add french translation (thanks Elfenduli) (provided by & closes #11) 2022-01-05 12:00:37 +01:00
3dbaf84db3 Update code for Foundry 9 2022-01-05 11:49:14 +01:00
cf3cbb892c Release v1.2.9 2021-07-20 11:21:15 +02:00
2ce7e57f43 Bring back the "tint secret doors" feature (resolves #7)
This partially reverts commit 42529d3df6.
2021-07-20 11:18:41 +02:00
e20b259d99 Release v1.2.8 2021-06-27 22:10:25 +02:00
13df0ccecd Update Smart Doors to work with the changed API (between Version 0.8.5 and 0.8.7). Update Smart Doors to work again (fixes #8) 2021-06-27 22:07:56 +02:00
8e565d24ae Release v1.2.7 2021-05-22 19:24:16 +02:00
81f455c63a Port the code to Foundry 0.8.5 2021-05-22 19:23:06 +02:00
42529d3df6 Remove features that are obsolete in 0.8 2021-05-22 19:06:09 +02:00
9a40e53d2e Allow bug reporter 2021-05-20 12:23:44 +02:00
01857f6ef4 Release v1.2.6 2021-05-05 01:10:57 +02:00
1215ddf55a Use libWrapper for function hooks (resolves #5) 2021-05-05 01:06:33 +02:00
2eca460637 Release v1.2.5 2021-03-14 00:40:54 +01:00
3461db568e Add ko-fi button 2021-03-14 00:40:54 +01:00
47c5eecd9c Add option for synchronizing the secret door state (resolves #3) 2021-03-14 00:35:33 +01:00
0f1975f9ae Release v1.2.4 2021-02-11 23:04:29 +01:00
aafa18a2c2 Fix a race condition that may cause doors to not synchronize across scenes 2021-02-11 23:03:18 +01:00
69b6542a18 Release v1.2.3 2021-02-10 11:07:27 +01:00
6b36b62e71 Make compatbile with the Arms Reach module 2021-02-10 11:06:03 +01:00
f905657e41 Reword "Planned features" section to "Feature ideas" 2021-02-10 10:56:17 +01:00
a2053c7328 Fix the naming of the Ctrl key (it was called Strg before) 2021-01-27 15:57:41 +01:00
e17845dd57 Release v1.2.2 2021-01-27 13:06:38 +01:00
ff6769f6a4 Inform the user about incompatibilities between Smart Doors and Arms Reach and offer help for conflict resolution 2021-01-27 13:06:33 +01:00
869fedd128 Always check first if a feature is enabled before doing anything else to increase compatibility with other modules 2021-01-27 12:43:47 +01:00
2a9d7e7acb Put more detailed author information in module.json 2021-01-13 23:42:52 +01:00
a4d5e6a131 Release v1.2.1 2020-12-20 09:51:05 +01:00
3c632a342d Release v1.2.0 2020-12-16 12:39:13 +01:00
82b495f4c3 Draw an outline around door control icons 2020-12-16 12:37:53 +01:00
f67899500e Make secret doors black instead of dark grey 2020-12-16 12:35:57 +01:00
17 changed files with 412 additions and 89 deletions

View File

@@ -1,3 +1,81 @@
## 1.3.2
### Bugfixes
- The message sent to chat when triggering a locke door alert can now be translated
### Translation
- Added japanese translation (thanks to touge)
- Added german translation
## 1.3.1
### Bugfixes
- The keybinding to toggle secret doors no longer supresses other keybindings that are assigned to the same key
## 1.3.0
### New features
- The keybinding for the Toggle Secret Door feature can now be reconfigured via Foundries keybinding configuration (the default key has changed to AltLeft)
### Compatibility
- Smart Doors is now compatible with Foundry 9
### Translation
- Added french translation (thanks to Elfenduli)
## 1.2.9
### Feature revival
- The "Tint secret doors" feature is back, but will remain disabled by default.
## 1.2.8
### Compatibility
- Smart Doors is now compatible with Foundry 0.8.8
- Due to API changes inside Foundry, Smart Doors is no longer compatible with Foundry versions older than 0.8.7
## 1.2.7
### Compatibility
- Smart Doors is now compatible with Foundry 0.8.5
### Feature removals
- The door icons now have outlines by defualt in Foundry. As a result the "Door Icon Outline" feature was removed.
- Secret doors now have a different icon from regular doors in Foundry, making the "Tint Secret Doors" feature redundant. As a result it was removed.
## 1.2.6
### Compatibility
- Smart Doors now uses the libwrapper module and as a result is now compatible with the module "FoundryVTT Arms Reach"
## 1.2.5
### New features
- Synchronized doors can now be configured to synchronize their secret door status as well
## v1.2.4
### Bugfix
- Fixed a race condition that may cause doors to not be properly synchronized across scenes
## v1.2.3
### Other
- Smart Doors is now compatible with Arms Reach
## v1.2.2
### Bugfix
- Disabled features are now less likely to interfere with other modules, increasing compatibility.
- This module can now be used together with the `Arms Reach` module if the `Toggle Secret Doors` feature is disabled in the settings.
### Other
- Warn the user about incompatibility if they use this module together with `Arms Reach` and have incompatible features enabled.
## v1.2.1
### Other
- Verified compatibility with 0.7.9
## v1.2.0
### New features
- Draw outlines around Door Control icons to increase their visibility
### Other
- Secret doors are now tinted black instead of dark grey.
## v1.1.0 ## v1.1.0
### New features ### New features
- Tint secret doors grey for the GM to differentiate them from regular doors - Tint secret doors grey for the GM to differentiate them from regular doors

View File

@@ -1,3 +1,5 @@
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/staebchenfisch)
# Smart Doors # Smart Doors
Makes doors smarter. Allows doors to synchronize across multiple scenes and sends chat messages when players try to open locked doors (and also tells you which of the doors). Makes doors smarter. Allows doors to synchronize across multiple scenes and sends chat messages when players try to open locked doors (and also tells you which of the doors).
@@ -8,16 +10,10 @@ Makes doors smarter. Allows doors to synchronize across multiple scenes and send
Door Control icons will be rendered the same size in every scene, regardless of the configured grid size. The size of the icons is configurable. Door Control icons will be rendered the same size in every scene, regardless of the configured grid size. The size of the icons is configurable.
### Tint Secret Doors
![Tint Secret Doors demonstration](https://raw.githubusercontent.com/manuelVo/foundryvtt-smart-doors/dc5d328cd9bc4a0e2aacc5c86ab59e15739cc6d1/media/tint_secret_doors.webp)
Which where the secret doors again? This tints all secret doors grey in the GM view, allowing to easily differentiate between normal and secret doors.
### Toggle Secret Doors ### Toggle Secret Doors
![Toggle Secret Doors demonstration](https://raw.githubusercontent.com/manuelVo/foundryvtt-smart-doors/da5872042ea81e2f41875a193d161331a81a2b6d/media/secret_door_toggle.webp) ![Toggle Secret Doors demonstration](https://raw.githubusercontent.com/manuelVo/foundryvtt-smart-doors/da5872042ea81e2f41875a193d161331a81a2b6d/media/secret_door_toggle.webp)
Easily reveal secret doors to players. Strg+left click secrets doors to turn them into regular doors. Strg+left click can also be done on normal doors to turn them into secret doors. Using this in combination with Tint Secret Doors is recommended so you can actually see what you are doing. Easily reveal secret doors to players. Alt+left click secrets doors to turn them into regular doors. Alt+left click can also be done on normal doors to turn them into secret doors. The keybinding for this feature can be reconfigured.
### Locked Door Alerts ### Locked Door Alerts
@@ -27,6 +23,10 @@ Keep everyone informed who tried to open which door. Whenever a player tries to
If the GM tries to open a locked door the sound will only played for him and no chat message will be sent. If the GM tries to open a locked door the sound will only played for him and no chat message will be sent.
### Tint Secret Doors
This tints secret doors in a gay shade to make them easier to discern from regular doors when being zoomed further out.
### Synchronized Doors ### Synchronized Doors
![Synchronized Doors demonstration](https://raw.githubusercontent.com/manuelVo/foundryvtt-smart-doors/360d724240634dbc6cc493a3b62243a8b28b7056/media/synchronized_doors.webp) ![Synchronized Doors demonstration](https://raw.githubusercontent.com/manuelVo/foundryvtt-smart-doors/360d724240634dbc6cc493a3b62243a8b28b7056/media/synchronized_doors.webp)
@@ -39,7 +39,7 @@ To set up door synchronization, assign all doors that should be synchronized to
Once a Synchronization Group is set up for multiple doors, simply open/close/lock/unlock one of the doors to achieve the same effect on other doors as well. Once a Synchronization Group is set up for multiple doors, simply open/close/lock/unlock one of the doors to achieve the same effect on other doors as well.
## Planned Features ## Features ideas
- Attach macros to doors that are being executed when the door is being opened/closed - Attach macros to doors that are being executed when the door is being opened/closed
- Give out keys to players, that allow them to lock/unlock associated doors - Give out keys to players, that allow them to lock/unlock associated doors
- Doors that can only be seen from one side when closed - Doors that can only be seen from one side when closed

41
lang/de.json Normal file
View File

@@ -0,0 +1,41 @@
{
"smart-doors": {
"keybindings": {
"toggleSecretDoor": {
"name": "Geheimtüren umschalten",
"hint": "Solange diese Taste gedrückt ist, werden Türen beim Klicken zwischen normaler Tür und Geheimtür umgeschalten."
}
},
"settings": {
"doorControlSizeFactor": {
"name": "Sklaierungsfaktor des Türsymbols",
"hint": "Legt fest um welchen faktor die Größe der Türsymbole hochskaliert werden sollen"
},
"highlightSecretDoors": {
"name": "Geheimtüren einfärben",
"hint": "Geheimtüren werden beim Spielleiter in einer anderen Farbe dargestellt, um sie einfacher von anderen Türen unterscheiden zu können."
},
"lockedDoorAlert": {
"name": "Alarm bei verschlossenen Türen",
"hint": "Wenn ein Spieler versucht eine verschlossene Tür zu öffnen wird eine Nachricht im Chat angezeigt"
},
"synchronizedDoors": {
"name": "Synchronisierte Türen",
"hint": "Erlaubt es den Zustand mehrerer Türen zu synchronisieren"
}
},
"ui": {
"lockedDoorAlert": "Hat versucht eine verschlossene Tür zu öffnen",
"messages": {
"migrating": "Update Smart Doors zur Version {version}. Bitte schließe die Anwendung nicht.",
"migrationDone": "Smart Doors wurde erfolgreich auf die Version {version} geupdated.",
"unknownVersion": "Das Update von Smart doors ist mit folgendem Fehler fehlgeschlagen: Unbekannte Version {version}. Bite melde diesen Fehler im Bugtracker von Smart Doors. Um Datenverlust zu vermeiden, dekativiere dieses Modul bis dieser Fehler behoben ist."
},
"synchronizedDoors": {
"description": "Zustandsänderungen von Türen in der gleichen Synchronisationsgruppe werden Szenenübergreifend synchronisiert. Lasse dieses Feld leer, wenn du diese Tür nicht Synchornisieren möchtest.",
"groupName": "Synchronisationsgruppe",
"synchronizeSecretStatus": "Geheimtürstatus synchronisieren"
}
}
}
}

View File

@@ -1,5 +1,11 @@
{ {
"smart-doors": { "smart-doors": {
"keybindings": {
"toggleSecretDoor": {
"name": "Toggle Secret Door",
"hint": "While this key is being pressed, clicking on doors will cause the to toggle between normal and secret door"
}
},
"settings": { "settings": {
"doorControlSizeFactor": { "doorControlSizeFactor": {
"name": "Door Control Size Factor", "name": "Door Control Size Factor",
@@ -16,13 +22,10 @@
"synchronizedDoors": { "synchronizedDoors": {
"name": "Synchronized Doors", "name": "Synchronized Doors",
"hint": "Synchronize the state of configured doors" "hint": "Synchronize the state of configured doors"
},
"toggleSecretDoors": {
"name": "Toggle Secret Doors",
"hint": "Toggle the door type between normal and secret using ctrl+left click"
} }
}, },
"ui": { "ui": {
"lockedDoorAlert": "Just tried to open a locked door",
"messages": { "messages": {
"migrating": "Migrating Smart Doors to version {version}. Please don't close the application.", "migrating": "Migrating Smart Doors to version {version}. Please don't close the application.",
"migrationDone": "Smart Doors successfully migrated to version {version}.", "migrationDone": "Smart Doors successfully migrated to version {version}.",
@@ -30,7 +33,8 @@
}, },
"synchronizedDoors": { "synchronizedDoors": {
"description": "State changes of doors in the same synchronization group will be synchronized across scenes. Leave blank to disable synchronization for this door.", "description": "State changes of doors in the same synchronization group will be synchronized across scenes. Leave blank to disable synchronization for this door.",
"groupName": "Synchronization Group" "groupName": "Synchronization Group",
"synchronizeSecretStatus": "Synchronize Secret Status"
} }
} }
} }

35
lang/fr.json Normal file
View File

@@ -0,0 +1,35 @@
{
"smart-doors": {
"settings": {
"doorControlSizeFactor": {
"name": "Facteur de taille de commande de porte",
"hint": "Définit par quel facteur la taille des icônes de contrôle de porte doit être agrandie"
},
"highlightSecretDoors": {
"name": "Teinte des portes secrètes",
"indice": "Ombragez les portes secrètes d'une couleur différente sur l'écran gm pour les différencier des portes normales"
},
"lockedDoorAlert": {
"name": "Alerte de porte verrouillée",
"hint": "Envoyer un message dans le chat lorsqu'un joueur essaie d'ouvrir une porte verrouillée"
},
"synchronizedDoors": {
"name": "Portes synchronisées",
"hint": "Synchroniser l'état des portes configurées"
}
}
},
"ui": {
"messages": {
"migrating": "Migration de Smart Doors vers la version {version}. Veuillez ne pas fermer l'application.",
"migrationDone": "Smart Doors a migré avec succès vers la version {version}.",
"unknownVersion": "La migration de Smart Doors a échoué avec l'erreur : Version inconnue {version}. Veuillez le signaler à l'outil de suivi des problèmes Smart Doors. Pour éviter une éventuelle perte de données, n'utilisez pas ce plug-in tant que cette erreur n'est pas corrigée."
},
"synchronizedDoors": {
"description": "Les changements d'état des portes dans le même groupe de synchronisation seront synchronisés entre les scènes. Laissez vide pour désactiver la synchronisation pour cette porte.",
"groupName": "Groupe de synchronisation",
"synchronizeSecretStatus": "Synchroniser le statut Secret"
}
}
}
}

40
lang/ja.json Normal file
View File

@@ -0,0 +1,40 @@
{
"smart-doors": {
"keybindings": {
"toggleSecretDoor": {
"name": "シークレット・ドア切替",
"hint": "このキーを押しながらドアをクリックすると、シークレット・ドアと通常のドアを切り替えます。"
}
},
"settings": {
"doorControlSizeFactor": {
"name": "扉アイコンの大きさ",
"hint": "扉アイコンをどの程度大きくスケールアップするか設定します。"
},
"highlightSecretDoors": {
"name": "シークレット・ドア色",
"hint": "シークレット・ドアに異なる色を重ねることで、GM側から視認しやすくなります。"
},
"lockedDoorAlert": {
"name": "ロック中通知",
"hint": "ロックされた扉を誰かが開けようとした時チャットに通知を表示します。"
},
"synchronizedDoors": {
"name": "扉の同期",
"hint": "設定した扉の状態を同期させます。"
}
},
"ui": {
"messages": {
"migrating": "Smart Doorsをバージョン{version}。にマイグレーションしています。FVTTを終了しないでください。",
"migrationDone": "Smart Doorsバージョン{version}のマイグレーションに成功しました。",
"unknownVersion": "Smart Doorsのマイグレーションに失敗しました。エラー不明なバージョン{version}。Smart Doorsのissue trackerに報告していただくか、オンセ工房のDiscordサーバまでご報告ください。データの損失が起こりうる可能性がありますので、このエラーが解消されるまで使用しないでください。"
},
"synchronizedDoors": {
"description": "同じ同期グループにいる扉はシーンをまたいで状態が同期されます。空の場合はこの扉の同期を無効化します。",
"groupName": "同期グループ名",
"synchronizeSecretStatus": "シークレット状態同期"
}
}
}
}

61
lib/libwrapper_shim.js Normal file
View File

@@ -0,0 +1,61 @@
// SPDX-License-Identifier: MIT
// Copyright © 2021 fvtt-lib-wrapper Rui Pinheiro
'use strict';
// A shim for the libWrapper library
export let libWrapper = undefined;
Hooks.once('init', () => {
// Check if the real module is already loaded - if so, use it
if(globalThis.libWrapper && !(globalThis.libWrapper.is_fallback ?? true)) {
libWrapper = globalThis.libWrapper;
return;
}
// Fallback implementation
libWrapper = class {
static get is_fallback() { return true };
static register(module, target, fn, type="MIXED", {chain=undefined}={}) {
const is_setter = target.endsWith('#set');
target = !is_setter ? target : target.slice(0, -4);
const split = target.split('.');
const fn_name = split.pop();
const root_nm = split.splice(0,1)[0];
const _eval = eval; // The browser doesn't expose all global variables (e.g. 'Game') inside globalThis, but it does to an eval. We copy it to a variable to have it run in global scope.
const obj = split.reduce((x,y)=>x[y], globalThis[root_nm] ?? _eval(root_nm));
let iObj = obj;
let descriptor = null;
while(iObj) {
descriptor = Object.getOwnPropertyDescriptor(iObj, fn_name);
if(descriptor) break;
iObj = Object.getPrototypeOf(iObj);
}
if(!descriptor || descriptor?.configurable === false) throw `libWrapper Shim: '${target}' does not exist, could not be found, or has a non-configurable descriptor.`;
let original = null;
const wrapper = (chain ?? type != 'OVERRIDE') ? function() { return fn.call(this, original.bind(this), ...arguments); } : function() { return fn.apply(this, arguments); };
if(!is_setter) {
if(descriptor.value) {
original = descriptor.value;
descriptor.value = wrapper;
}
else {
original = descriptor.get;
descriptor.get = wrapper;
}
}
else {
if(!descriptor.set) throw `libWrapper Shim: '${target}' does not have a setter`;
original = descriptor.set;
descriptor.set = wrapper;
}
descriptor.configurable = true;
Object.defineProperty(obj, fn_name, descriptor);
}
}
});

View File

@@ -2,24 +2,47 @@
"name": "smart-doors", "name": "smart-doors",
"title": "Smart Doors", "title": "Smart Doors",
"description": "Makes doors smarter. Allows doors to synchronize across multiple scenes and sends chat messages when players try to open locked doors.", "description": "Makes doors smarter. Allows doors to synchronize across multiple scenes and sends chat messages when players try to open locked doors.",
"version": "1.1.0", "version": "1.3.2",
"minimumCoreVersion" : "0.7.7", "minimumCoreVersion" : "9.238",
"compatibleCoreVersion" : "0.7.8", "compatibleCoreVersion" : "9",
"author": "Manuel Vögele", "authors": [
{
"name": "Manuel Vögele",
"email": "develop@manuel-voegele.de",
"discord": "Stäbchenfisch#5107"
}
],
"esmodules": [ "esmodules": [
"lib/libwrapper_shim.js",
"src/main.js" "src/main.js"
], ],
"languages": [ "languages": [
{
"lang": "de",
"name": "Deutsch",
"path": "lang/de.json"
},
{ {
"lang": "en", "lang": "en",
"name": "English", "name": "English",
"path": "lang/en.json" "path": "lang/en.json"
},
{
"lang": "fr",
"name": "Français",
"path": "lang/fr.json"
},
{
"lang": "ja",
"name": "日本語",
"path": "lang/ja.json"
} }
], ],
"url": "https://github.com/manuelVo/foundryvtt-smart-doors", "url": "https://github.com/manuelVo/foundryvtt-smart-doors",
"manifest": "https://raw.githubusercontent.com/manuelVo/foundryvtt-smart-doors/master/module.json", "manifest": "https://raw.githubusercontent.com/manuelVo/foundryvtt-smart-doors/master/module.json",
"download": "https://github.com/manuelVo/foundryvtt-smart-doors/archive/v1.1.0.zip", "download": "https://github.com/manuelVo/foundryvtt-smart-doors/archive/v1.3.2.zip",
"readme": "https://github.com/manuelVo/foundryvtt-smart-doors/blob/master/README.md", "readme": "https://github.com/manuelVo/foundryvtt-smart-doors/blob/master/README.md",
"changelog": "https://github.com/manuelVo/foundryvtt-smart-doors/blob/master/CHANGELOG.md", "changelog": "https://github.com/manuelVo/foundryvtt-smart-doors/blob/master/CHANGELOG.md",
"bugs": "https://github.com/manuelVo/foundryvtt-smart-doors/issues" "bugs": "https://github.com/manuelVo/foundryvtt-smart-doors/issues",
"allowBugReporter": true
} }

View File

@@ -1,22 +1,14 @@
import { libWrapper } from "../../lib/libwrapper_shim.js"
import {settingsKey} from "../settings.js" import {settingsKey} from "../settings.js"
// Adjust the repositioning formula for the door controls // Adjust the repositioning formula for the door controls
export function hookDoorControlReposition() { export function hookDoorControlReposition() {
DoorControl.prototype.reposition = function () { libWrapper.register("smart-doors", "DoorControl.prototype.reposition", function () {
let gridSize = this.wall.scene.data.grid let gridSize = this.wall.scene.data.grid
gridSize *= game.settings.get(settingsKey, "doorControlSizeFactor") gridSize *= game.settings.get(settingsKey, "doorControlSizeFactor")
const pos = this.wall.midpoint.map(p => p - gridSize * 0.2) const pos = this.wall.midpoint.map(p => p - gridSize * 0.2)
this.position.set(...pos) this.position.set(...pos)
} }, "OVERRIDE");
}
export function hookDoorControlDraw() {
const originalHandler = DoorControl.prototype.draw
DoorControl.prototype.draw = async function () {
const result = await originalHandler.call(this)
onDoorControlPostDraw.call(this)
return result
}
} }
// Set the size of all door controls in relation to the grid size so it'll have a constant percieved size // Set the size of all door controls in relation to the grid size so it'll have a constant percieved size
@@ -26,7 +18,7 @@ export function onCanvasReady(currentCanvas) {
} }
// Set the size of the door control in relation to the grid size so it'll have a constant percieved size // Set the size of the door control in relation to the grid size so it'll have a constant percieved size
function onDoorControlPostDraw() { export function onDoorControlPostDraw() {
// If the canvas isn't ready we'll do this after the "canvasReady" event is fired instead // If the canvas isn't ready we'll do this after the "canvasReady" event is fired instead
if (!canvas.ready) if (!canvas.ready)
return return

View File

@@ -1,6 +1,6 @@
import {settingsKey} from "../settings.js" import {settingsKey} from "../settings.js"
const SECRET_DOOR_TINT = 0x222222 const SECRET_DOOR_TINT = 0x888888
// Tint all secret doors dark grey // Tint all secret doors dark grey
export function onCanvasReady(currentCanvas) { export function onCanvasReady(currentCanvas) {

View File

@@ -9,7 +9,7 @@ export function onRenderChatMessage(message, html, data) {
// Tint on mouse enter // Tint on mouse enter
const mouseEnter = function () { const mouseEnter = function () {
const sourceDoor = canvas.controls.doors.children.find(door => door.wall.data._id === source.wall && door.wall.scene.id === source.scene); const sourceDoor = canvas.controls.doors.children.find(door => door.wall.id === source.wall && door.wall.scene.id === source.scene);
if (sourceDoor) if (sourceDoor)
sourceDoor.icon.tint = 0xff0000; sourceDoor.icon.tint = 0xff0000;
} }
@@ -17,24 +17,27 @@ export function onRenderChatMessage(message, html, data) {
// Remove tint on mouse leave // Remove tint on mouse leave
const mouseLeave = function () { const mouseLeave = function () {
const sourceDoor = canvas.controls.doors.children.find(door => door.wall.data._id === source.wall && door.wall.scene.id === source.scene); const sourceDoor = canvas.controls.doors.children.find(door => door.wall.id === source.wall && door.wall.scene.id === source.scene);
if (sourceDoor) if (sourceDoor)
sourceDoor.icon.tint = 0xffffff; sourceDoor.icon.tint = 0xffffff;
} }
html.on("mouseleave", mouseLeave); html.on("mouseleave", mouseLeave);
// Localize the message
html.find(".message-content")[0].innerText = game.i18n.localize("smart-doors.ui.lockedDoorAlert");
} }
// Creates a chat message stating that a player tried to open a locked door // Creates a chat message stating that a player tried to open a locked door
export function onDoorLeftClick() { export function onDoorLeftClick() {
const state = this.wall.data.ds
const states = CONST.WALL_DOOR_STATES
// Check if this feature is enabled // Check if this feature is enabled
if (!game.settings.get(settingsKey, "lockedDoorAlert")) if (!game.settings.get(settingsKey, "lockedDoorAlert"))
return false return false
const state = this.wall.data.ds
const states = CONST.WALL_DOOR_STATES
// Only create messages when the door is locked. // Only create messages when the door is locked.
if (state != states.LOCKED) if (state !== states.LOCKED)
return false return false
// Generate no message if the gm attempts to open the door // Generate no message if the gm attempts to open the door
@@ -43,10 +46,10 @@ export function onDoorLeftClick() {
// Create and send the chat message // Create and send the chat message
const message = {} const message = {}
message.user = game.user message.user = game.user.id;
if (game.user.character) if (game.user.character)
message.speaker = {actor: game.user.character} message.speaker = {actor: game.user.character}
message.content = "Just tried to open a locked door" message.content = game.i18n.localize("smart-doors.ui.lockedDoorAlert");
message.sound = CONFIG.sounds.lock message.sound = CONFIG.sounds.lock
message.flags = {smartdoors: {source: {wall: this.wall.data._id, scene: this.wall.scene.id}}} message.flags = {smartdoors: {source: {wall: this.wall.data._id, scene: this.wall.scene.id}}}
ChatMessage.create(message) ChatMessage.create(message)

View File

@@ -3,7 +3,7 @@ import * as Util from "../util.js"
// Inject settings for synchronized doors // Inject settings for synchronized doors
export function onRederWallConfig(wallConfig, html, data) { export function onRederWallConfig(wallConfig, html, data) {
if (data.isDoor && game.settings.get(settingsKey, "synchronizedDoors")) { if (game.settings.get(settingsKey, "synchronizedDoors") && data.isDoor) {
// Inject settings // Inject settings
const synchronizedSettings = ` const synchronizedSettings = `
<p class="notes">${game.i18n.localize("smart-doors.ui.synchronizedDoors.description")}</p> <p class="notes">${game.i18n.localize("smart-doors.ui.synchronizedDoors.description")}</p>
@@ -11,13 +11,18 @@ export function onRederWallConfig(wallConfig, html, data) {
<label for="synchronizationGroup">${game.i18n.localize("smart-doors.ui.synchronizedDoors.groupName")}</label> <label for="synchronizationGroup">${game.i18n.localize("smart-doors.ui.synchronizedDoors.groupName")}</label>
<input type="text" name="synchronizationGroup"/> <input type="text" name="synchronizationGroup"/>
</div> </div>
<div class="form-group">
<label for="synchronizeSecretStatus">${game.i18n.localize("smart-doors.ui.synchronizedDoors.synchronizeSecretStatus")}</label>
<input type="checkbox" name="synchronizeSecretStatus" value="true"/>
</div>
` `
html.find(".form-group").last().after(synchronizedSettings) html.find(".form-group").last().after(synchronizedSettings)
const smartdoorsData = data.object.flags.smartdoors const smartdoorsData = data.object.flags.smartdoors
// Fill the injected input fields with values // Fill the injected input fields with values
const input = (name) => html.find(`input[name="${name}"]`) const input = (name) => html.find(`input[name="${name}"]`); // input is a helper function to search for a input field by it's name
input("synchronizationGroup").prop("value", smartdoorsData?.synchronizationGroup) input("synchronizationGroup").prop("value", smartdoorsData?.synchronizationGroup)
input("synchronizeSecretStatus").prop("checked", smartdoorsData?.synchronizeSecretStatus);
// Recalculate config window height // Recalculate config window height
wallConfig.setPosition({height: "auto"}) wallConfig.setPosition({height: "auto"})
@@ -26,37 +31,51 @@ export function onRederWallConfig(wallConfig, html, data) {
// Store our custom data from the WallConfig dialog // Store our custom data from the WallConfig dialog
export async function onWallConfigUpdate(event, formData) { export async function onWallConfigUpdate(event, formData) {
const updateData = {flags: {smartdoors: {synchronizationGroup: formData.synchronizationGroup}}} const synchronizeSecretStatus = formData.synchronizeSecretStatus;
let ids = this.options.editTargets; const updateData = {flags: {smartdoors: {synchronizationGroup: formData.synchronizationGroup}}};
let ids = this.editTargets;
if (ids.length == 0) { if (ids.length == 0) {
ids = [this.object.data._id]; ids = [this.object.id];
} }
// If a synchronization group is set, get the state of existing doors and assume their state // If a synchronization group is set, get the state of existing doors and assume their state
if (formData.synchronizationGroup) { if (formData.synchronizationGroup) {
// Update the synchronizeSecretStatus flag
updateData.flags.smartdoors.synchronizeSecretStatus = synchronizeSecretStatus;
// Search for other doors in the synchronization group that aren't in the list of edited doors // Search for other doors in the synchronization group that aren't in the list of edited doors
const doorInGroup = Util.findInAllWalls(wall => { const doorInGroup = Util.findInAllWalls(wall => {
// We only search for doors // We only search for doors
if (!wall.door) if (!wall.data.door)
return false return false
// We only want doors in the same synchronization group // We only want doors in the same synchronization group
if (wall.flags.smartdoors?.synchronizationGroup !== formData.synchronizationGroup) if (wall.data.flags.smartdoors?.synchronizationGroup !== formData.synchronizationGroup)
return false return false
// Doors on this scene that have their id included in `ids` are currently being changed. Ignore them. // Doors on this scene that have their id included in `ids` are currently being changed. Ignore them.
if (wall.scene === canvas.scene && ids.includes(wall._id)) if (wall.parent.id === canvas.scene.id && ids.includes(wall.id))
return false return false
return true return true
}) })
if (doorInGroup) if (doorInGroup) {
updateData.ds = doorInGroup.ds; // ds is the door sate in foundry
updateData.ds = doorInGroup.data.ds;
if (synchronizeSecretStatus) {
// door is the door type in foundry
updateData.door = doorInGroup.data.door;
}
}
} }
// Update all the edited walls // Update all the edited walls
const updateDataset = ids.reduce((dataset, id) => { const updateDataset = ids.map(id => {return {_id: id, ...updateData}});
dataset.push({_id: id, ...updateData}) const updateResult = await canvas.scene.updateEmbeddedDocuments("Wall", updateDataset);
return dataset
}, []) // If door is synchronized, synchronize secret status among synchronized doors
return canvas.scene.updateEmbeddedEntity("Wall", updateDataset) if (formData.synchronizationGroup)
await updateSynchronizedDoors(updateData, formData.synchronizationGroup);
return updateResult;
} }
// Update the state of all synchronized doors // Update the state of all synchronized doors
@@ -121,12 +140,10 @@ export function onDoorRightClick() {
} }
// Updates all doors in the specified synchronization group with the provided data // Updates all doors in the specified synchronization group with the provided data
function updateSynchronizedDoors(updateData, synchronizationGroup) { export function updateSynchronizedDoors(updateData, synchronizationGroup) {
// Search for doors belonging to the synchronization group in all scenes // Search for doors belonging to the synchronization group in all scenes
let scenes = Util.filterAllWalls(wall => wall.door && wall.flags.smartdoors?.synchronizationGroup === synchronizationGroup); let scenes = Util.filterAllWalls(wall => wall.data.door && wall.data.flags.smartdoors?.synchronizationGroup === synchronizationGroup);
// Update all doors in the synchronization group // Update all doors in the synchronization group
scenes.forEach((scene) => { return Promise.all(scenes.map(scene => scene.scene.updateEmbeddedDocuments("Wall", scene.walls.map((wall) => {return {_id: wall.id, ...updateData}}))));
scene.scene.updateEmbeddedEntity("Wall", scene.walls.map((wall) => {return {_id: wall._id, ...updateData}}))
})
} }

View File

@@ -1,11 +1,20 @@
import {toggleSecretDoor} from "../keybindings.js";
import {settingsKey} from "../settings.js" import {settingsKey} from "../settings.js"
import {updateSynchronizedDoors} from "./synchronized_doors.js";
// Toggles between normal and secret doors // Toggles between normal and secret doors
export function onDoorLeftClick(event) { export function onDoorLeftClick() {
if (event.data.originalEvent.ctrlKey && game.user.isGM && game.settings.get(settingsKey, "toggleSecretDoors")) { // We don't trust the event to be filled with the expected data for compatibilty with arms reach (which passes a broken event)
if (toggleSecretDoor && game.user.isGM) {
const types = CONST.WALL_DOOR_TYPES const types = CONST.WALL_DOOR_TYPES
const newtype = this.wall.data.door === types.DOOR ? types.SECRET : types.DOOR const newtype = this.wall.data.door === types.DOOR ? types.SECRET : types.DOOR
this.wall.update({door: newtype}) const updateData = {door: newtype}
const synchronizationGroup = this.wall.data.flags.smartdoors?.synchronizationGroup
if (game.settings.get(settingsKey, "synchronizedDoors") && synchronizationGroup && this.wall.data.flags.smartdoors?.synchronizeSecretStatus)
updateSynchronizedDoors(updateData, synchronizationGroup)
else
this.wall.document.update(updateData)
return true return true
} }
return false return false

20
src/keybindings.js Normal file
View File

@@ -0,0 +1,20 @@
import {settingsKey} from "./settings.js";
export let toggleSecretDoor = false;
export function registerKeybindings() {
game.keybindings.register(settingsKey, "toggleSecretDoor", {
name: "smart-doors.keybindings.toggleSecretDoor.name",
hint: "smart-doors.keybindings.toggleSecretDoor.hint",
onDown: handleToggleSecretDoor,
onUp: handleToggleSecretDoor,
restricted: true,
editable: [{key: "AltLeft"}],
precedence: -1,
});
}
function handleToggleSecretDoor(event) {
toggleSecretDoor = !event.up;
return false;
}

View File

@@ -1,5 +1,6 @@
"use strict"; "use strict";
import {libWrapper} from "../lib/libwrapper_shim.js";
import * as DoorControlIconScale from "./features/door_control_icon_scale.js" import * as DoorControlIconScale from "./features/door_control_icon_scale.js"
import * as HighlightSecretDoors from "./features/highlight_secret_doors.js" import * as HighlightSecretDoors from "./features/highlight_secret_doors.js"
import * as LockedDoorAlert from "./features/locked_door_alert.js" import * as LockedDoorAlert from "./features/locked_door_alert.js"
@@ -7,13 +8,16 @@ import * as SynchronizedDoors from "./features/synchronized_doors.js"
import * as ToggleSecretDoor from "./features/toggle_secret_door.js" import * as ToggleSecretDoor from "./features/toggle_secret_door.js"
import {performMigrations} from "./migration.js" import {performMigrations} from "./migration.js"
import {registerSettings} from "./settings.js" import {registerKeybindings} from "./keybindings.js"
import {registerSettings, settingsKey} from "./settings.js"
Hooks.once("init", () => { Hooks.once("init", () => {
registerSettings() registerSettings()
registerKeybindings()
hookDoorEvents() hookDoorEvents()
hookWallConfigUpdate() hookWallConfigUpdate()
DoorControlIconScale.hookDoorControlDraw() hookDoorControlDraw()
DoorControlIconScale.hookDoorControlReposition() DoorControlIconScale.hookDoorControlReposition()
}) })
@@ -24,7 +28,6 @@ Hooks.once("ready", () => {
Hooks.on("renderChatMessage", LockedDoorAlert.onRenderChatMessage) Hooks.on("renderChatMessage", LockedDoorAlert.onRenderChatMessage)
Hooks.on("canvasReady", DoorControlIconScale.onCanvasReady) Hooks.on("canvasReady", DoorControlIconScale.onCanvasReady)
Hooks.on("canvasReady", HighlightSecretDoors.onCanvasReady) Hooks.on("canvasReady", HighlightSecretDoors.onCanvasReady)
Hooks.on("updateWall", HighlightSecretDoors.onUpdateWall) Hooks.on("updateWall", HighlightSecretDoors.onUpdateWall)
@@ -35,35 +38,40 @@ Hooks.on("renderWallConfig", SynchronizedDoors.onRederWallConfig)
// Hook the update function of the WallConfig dialog so we can store our custom data // Hook the update function of the WallConfig dialog so we can store our custom data
function hookWallConfigUpdate() { function hookWallConfigUpdate() {
// Replace the original function with our custom one // Replace the original function with our custom one
const originalHandler = WallConfig.prototype._updateObject; libWrapper.register("smart-doors", "WallConfig.prototype._updateObject", async function (wrapped, event, formData) {
WallConfig.prototype._updateObject = async function (event, formData) { await wrapped(event, formData);
await originalHandler.call(this, event, formData)
return SynchronizedDoors.onWallConfigUpdate.call(this, event, formData) return SynchronizedDoors.onWallConfigUpdate.call(this, event, formData)
}, "WRAPPER");
} }
function hookDoorControlDraw() {
libWrapper.register("smart-doors", "DoorControl.prototype.draw", async function (wrapped) {
const result = await wrapped();
DoorControlIconScale.onDoorControlPostDraw.call(this)
return result;
}, "WRAPPER");
} }
// Hook mouse events on DoorControls to perform our logic. // Hook mouse events on DoorControls to perform our logic.
// If we successfully handled the event block the original handler. Forward the event otherwise. // If we successfully handled the event block the original handler. Forward the event otherwise.
function hookDoorEvents() { function hookDoorEvents() {
// Replace the original mousedown handler with our custom one // Replace the original mousedown handler with our custom one
const originalMouseDownHandler = DoorControl.prototype._onMouseDown libWrapper.register("smart-doors", "DoorControl.prototype._onMouseDown", function (wrapped, event) {
DoorControl.prototype._onMouseDown = function (event) {
// Call our handler first. Only allow the original handler to run if our handler returns true // Call our handler first. Only allow the original handler to run if our handler returns true
const eventHandled = onDoorMouseDown.call(this, event) const eventHandled = onDoorMouseDown.call(this, event)
if (eventHandled) if (eventHandled)
return return
return originalMouseDownHandler.call(this, event) return wrapped(event);
} }, "MIXED");
// Replace the original rightdown handler with our custom one // Replace the original rightdown handler with our custom one
const originalRightDownHandler = DoorControl.prototype._onRightDown libWrapper.register("smart-doors", "DoorControl.prototype._onRightDown", function (wrapped, event) {
DoorControl.prototype._onRightDown = function (event) {
// Call our handler first. Only allow the original handler to run if our handler returns true // Call our handler first. Only allow the original handler to run if our handler returns true
const eventHandled = onDoorRightDown.call(this, event) const eventHandled = onDoorRightDown.call(this, event)
if (eventHandled) if (eventHandled)
return return
return originalRightDownHandler.call(this, event) return wrapped(event);
} }, "MIXED");
} }
// Our custom handler for mousedown events on doors // Our custom handler for mousedown events on doors

View File

@@ -20,9 +20,9 @@ export function performMigrations() {
// Make a dictionary that maps all door ids to their scenes // Make a dictionary that maps all door ids to their scenes
const walls = game.scenes.reduce((dict, scene) => { const walls = game.scenes.reduce((dict, scene) => {
scene.data.walls.forEach(wall => { scene.data.walls.forEach(wall => {
if (!wall.door) if (!wall.data.door)
return return
dict[wall._id] = scene.id dict[wall.id] = scene.id;
}) })
return dict return dict
}, {}) }, {})

View File

@@ -27,17 +27,9 @@ export function registerSettings() {
scope: "world", scope: "world",
config: true, config: true,
type: Boolean, type: Boolean,
default: true, default: false,
onChange: reloadGM, onChange: reloadGM,
}) })
game.settings.register(settingsKey, "toggleSecretDoors", {
name: "smart-doors.settings.toggleSecretDoors.name",
hint: "smart-doors.settings.toggleSecretDoors.hint",
scope: "world",
config: true,
type: Boolean,
default: true,
})
game.settings.register(settingsKey, "lockedDoorAlert", { game.settings.register(settingsKey, "lockedDoorAlert", {
name: "smart-doors.settings.lockedDoorAlert.name", name: "smart-doors.settings.lockedDoorAlert.name",
hint: "smart-doors.settings.lockedDoorAlert.hint", hint: "smart-doors.settings.lockedDoorAlert.hint",