Update TokenConfig and DefaultTokenConfig #2326
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
sapphie132
commented
Dec 16, 2022
•
sapphie132
commented
- Closes Update TokenConfig for Foundry VTT v10.286 #1891
- Closes Update DefaultTokenConfig for Foundry VTT v10.274 #1892
This was referenced Dec 17, 2022
kmoschcau
requested changes
Jun 10, 2023
| @@ -7,18 +8,21 @@ declare global { | |||
| * be changed in v10. | |||
There was a problem hiding this comment.
A piece of this comment was removed in V10. It should also be removed here.
| Options, | ||
| InstanceType<ConfiguredDocumentClassForName<"Token">> | InstanceType<ConfiguredDocumentClassForName<"Actor">> | ||
| > { | ||
| class TokenConfig<Options extends DocumentSheetOptions = DocumentSheetOptions> extends DocumentSheet<Options> { | ||
| constructor( |
There was a problem hiding this comment.
Doc comments for the parameters should be copied over from the sources.
| actor: InstanceType<ConfiguredDocumentClassForName<"Actor">>; | ||
| /** Preserve a copy of the original document before any changes are made. */ | ||
| // TODO: unsure about this type. | ||
| original: TokenData["_source"]; |
There was a problem hiding this comment.
Suggested change
| original: TokenData["_source"]; | |
| original: BaseToken.Source; |
| static override get defaultOptions(): FormApplicationOptions; | ||
|
|
||
| override get id(): string; | ||
| static override get defaultOptions(): DocumentSheetOptions; |
There was a problem hiding this comment.
Please also update the documented default return value.
| * @internal | ||
| * Mimic changes to the Token document as if they were true document updates. | ||
| * @param change - Data which simulates a document update | ||
| * @param reset - To know if this preview change is a reset. Defaults to false. |
There was a problem hiding this comment.
Suggested change
| * @param reset - To know if this preview change is a reset. Defaults to false. | |
| * @param reset - To know if this preview change is a reset. Defaults to false. |
| @@ -87,7 +98,16 @@ declare global { | |||
| * Handle changing the attribute bar in the drop-down selector to update the default current and max value | |||
| * @internal | |||
| */ | |||
| protected _onBarChange(ev: JQuery.ChangeEvent): void; | |||
| protected _onBarChange(event: JQuery.ChangeEvent): void; | |||
There was a problem hiding this comment.
This now has parameter documentation, which should be added.
Comment on lines
+105
to
+106
| * @param event - The originating click event */ | ||
| protected _onClickActionButton(event: JQuery.ClickEvent): void; |
There was a problem hiding this comment.
Suggested change
| * @param event - The originating click event */ | |
| protected _onClickActionButton(event: JQuery.ClickEvent): void; | |
| * @param event - The originating click event | |
| */ | |
| protected _onClickActionButton(event: JQuery.ClickEvent): void; |
Comment on lines
+107
to
+110
| /** | ||
| * Disable the user's ability to edit the token image field if wildcard images are enabled and that user does not have | ||
| * file browser permissions. */ | ||
| private _disableEditImage(): void; |
There was a problem hiding this comment.
Suggested change
| /** | |
| * Disable the user's ability to edit the token image field if wildcard images are enabled and that user does not have | |
| * file browser permissions. */ | |
| private _disableEditImage(): void; | |
| /** | |
| * Disable the user's ability to edit the token image field if wildcard images are enabled and that user does not have | |
| * file browser permissions. | |
| */ | |
| private _disableEditImage(): void; |
| @@ -158,7 +176,7 @@ declare global { | |||
| * }) | |||
| * ``` | |||
| */ | |||
| static override get defaultOptions(): FormApplicationOptions; | |||
| static override get defaultOptions(): DocumentSheetOptions; | |||
|
|
|||
| override get id(): string; | |||
|
|
|||
There was a problem hiding this comment.
getData's parameter is now optional.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.