Core Foundry Documentation Issues (v12)

[LukeAbby]

Please use this master issue to document all Core Foundry v12 documentation issues. This will eventually be filed as an issue on the Foundry issue tracker but in the meantime batching up issues is helpful. You may either edit this issue to add issues in a list below or make a comment on this issue in order to add to the list of known issues.

[JPMeehan]

• Now that Foundry is using templates, Collection should just be Collection<T> instead of Collection<string, T>
• The type BasseEffectSourceOptions has a typo with an extra s in resources/app/client-esm/canvas/sources/base-effect-source.mjs
• Static methods can't use template properties, e.g. BaseEffectSource.defaultData
• The type definition of BaseEffectSource#initialize references options.behaviors but never actually references or uses that object.
• RenderedEffectSource refers to VisionMode.LIGHTING_LEVELS multiple times when that should be referring to CONST.LIGHTING_LEVELS
• PointEffectSourceMixin fails to supply its internal properties to the generated docs as well as any generated types
• PointVisionSource._brightLightingLevel mis-types the return as string instead of number
• The second parameter of PointVisionSource#_updateVisionModeUniforms is typed as an array, but it should be a Record as seen by the use of const [uniform, value] of vmUniforms
• CameraPopoutAppWrapper#_onResize is a no-op.
• EnrichmentAnchorOptions in TextEditor uses @param instead of @property causing the property definitions to fail
• The callback parameter for SearchFilter is typed as Function; a more specific type should be provided to list the arguments and expected return value (void)
• Game#toggleCharacterSheet can also return ActorSheetV2
• ActorSheetV2#actor is typed as ClientDocument instead of Actor

[esheyw]

• static fragmentShader is not marked @override or @inheritdoc in the following classes:
  • VoidFilter
  • BewitchingWaveIlluminationShader
  • BewitchingWaveColorationShader
  • FlameIlluminationShader
  • FlameColorationShader
  • GhostLightIlluminationShader
  • GhostLightColorationShader
  • PulseIlluminationShader
  • PulseColorationShader
  • RoilingDarknessShader
  • SirenColorationShader
  • SirenIlluminationShader
  • SmokePatchColorationShader
  • SmokePatchIlluminationShader
  • SunburstIlluminationShader
  • SunburstColorationShader
  • TorchIlluminationShader
  • TorchColorationShader
  • VortexIlluminationShader
  • WaveIlluminationShader
  • WaveColorationShader
• AdaptiveIllunimationShader.EXPOSURE is not marked @override
• VisionMaskFilter#enabled is a getter that overrides a PIXI.Filter property (vscode is wrong about how far back it goes): https://i.imgur.com/HxwBxqk.png

[LukeAbby]

Foundry does not document the file client-esm/dice/grammar.pegjs. This is primarily because it is a .pegjs file but they actually are able to document it if they generate documentation using this as of yet unreleased PR to Peggy.

Note: This isn't really an issue for fvtt-types as we can just generate the types ourselves. However people who want to see documentation for foundry.dice.RollGrammar will be unable to in core Foundry documentation.

[NekroDarkmoon]

foundry.dice.terms.DiceTerm#countEven and foundry.dice.terms.DiceTerm#countOdd take in a modifier argument but goes unused in the function itself.

[esheyw]

The type ShaderTechnique in client\pixi\webgl\shaders\lighting\base-lighting.js types several properties as |undefined without marking them as optional with []

[esheyw]

BaseSamplerShader.batchDefaultUniforms is set to {} and typed as object. However all three subclasses that override it (with inconsistent use of @override or @inheritDoc) supply a method with a single maxTex argument.