Skip to content

Add help page links to some effects reference help pages #8646

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
4ian merged 1 commit into from
May 27, 2026
Merged

Add help page links to some effects reference help pages #8646

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Extensions/3D/JsExtension.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2200,6 +2200,7 @@ module.exports = {
)
.markAsNotWorkingForObjects()
.markAsOnlyWorkingFor3D()
.setHelpPath('/objects/3d-light')
.addIncludeFile('Extensions/3D/AmbientLight.js');
const properties = effect.getProperties();
properties
Expand All @@ -2224,6 +2225,7 @@ module.exports = {
)
.markAsNotWorkingForObjects()
.markAsOnlyWorkingFor3D()
.setHelpPath('/objects/3d-light')
.addIncludeFile('Extensions/3D/DirectionalLight.js');
const properties = effect.getProperties();
properties
Expand Down Expand Up @@ -2314,6 +2316,7 @@ module.exports = {
)
.markAsNotWorkingForObjects()
.markAsOnlyWorkingFor3D()
.setHelpPath('/objects/3d-light')
.addIncludeFile('Extensions/3D/HemisphereLight.js');
const properties = effect.getProperties();
properties
Expand Down
10 changes: 10 additions & 0 deletions Extensions/Effects/JsExtension.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,7 @@ module.exports = {
.setFullName(_('Color Map'))
.setDescription(_('Change the color rendered on screen.'))
.markAsOnlyWorkingFor2D()
.setHelpPath('/all-features/effects/color-map')
.addIncludeFile('Extensions/Effects/color-map-pixi-filter.js')
.addIncludeFile('Extensions/Effects/pixi-filters/filter-color-map.js');
const colorMapProperties = colorMapEffect.getProperties();
Expand Down Expand Up @@ -371,6 +372,7 @@ module.exports = {
.setFullName(_('CRT'))
.setDescription(_('Apply an effect resembling old CRT monitors.'))
.markAsOnlyWorkingFor2D()
.setHelpPath('/all-features/effects/crt')
.addIncludeFile('Extensions/Effects/pixi-filters/filter-crt.js')
.addIncludeFile('Extensions/Effects/crt-pixi-filter.js');
const crtProperties = crtEffect.getProperties();
Expand Down Expand Up @@ -449,6 +451,7 @@ module.exports = {
)
)
.markAsOnlyWorkingFor2D()
.setHelpPath('/all-features/effects/displacement')
.addIncludeFile('Extensions/Effects/displacement-pixi-filter.js');
const displacementProperties = displacementEffect.getProperties();
displacementProperties
Expand Down Expand Up @@ -502,6 +505,7 @@ module.exports = {
.setFullName(_('Drop shadow'))
.setDescription(_('Add a shadow around the rendered image.'))
.markAsOnlyWorkingFor2D()
.setHelpPath('/all-features/effects/drop-shadow')
.addIncludeFile('Extensions/Effects/pixi-filters/filter-kawase-blur.js')
.addIncludeFile('Extensions/Effects/pixi-filters/filter-drop-shadow.js')
.addIncludeFile('Extensions/Effects/drop-shadow-pixi-filter.js');
Expand Down Expand Up @@ -673,6 +677,7 @@ module.exports = {
.setFullName(_('Godray'))
.setDescription(_('Apply and animate atmospheric light rays.'))
.markAsOnlyWorkingFor2D()
.setHelpPath('/all-features/effects/god-rays')
.addIncludeFile('Extensions/Effects/pixi-filters/filter-godray.js')
.addIncludeFile('Extensions/Effects/godray-pixi-filter.js');
const godrayProperties = godrayEffect.getProperties();
Expand Down Expand Up @@ -771,6 +776,7 @@ module.exports = {
)
)
.markAsOnlyWorkingFor2D()
.setHelpPath('/all-features/effects/kawase-blur')
.addIncludeFile('Extensions/Effects/pixi-filters/filter-kawase-blur.js')
.addIncludeFile('Extensions/Effects/kawase-blur-pixi-filter.js');
const kawaseBlurProperties = kawaseBlurEffect.getProperties();
Expand Down Expand Up @@ -951,6 +957,7 @@ module.exports = {
.setFullName(_('Outline'))
.setDescription(_('Draws an outline around the rendered image.'))
.markAsOnlyWorkingFor2D()
.setHelpPath('/all-features/effects/outline')
.addIncludeFile('Extensions/Effects/pixi-filters/filter-outline.js')
.addIncludeFile('Extensions/Effects/outline-pixi-filter.js');
const outlineProperties = outlineEffect.getProperties();
Expand Down Expand Up @@ -978,6 +985,7 @@ module.exports = {
_("Applies a pixelate effect, making display objects appear 'blocky'.")
)
.markAsOnlyWorkingFor2D()
.setHelpPath('/all-features/effects/pixelate')
.addIncludeFile('Extensions/Effects/pixi-filters/filter-pixelate.js')
.addIncludeFile('Extensions/Effects/pixelate-pixi-filter.js');
const pixelateProperties = pixelateEffect.getProperties();
Expand Down Expand Up @@ -1111,6 +1119,7 @@ module.exports = {
_('Applies a RGB split effect also known as chromatic aberration.')
)
.markAsOnlyWorkingFor2D()
.setHelpPath('/all-features/effects/rgb-split')
.addIncludeFile('Extensions/Effects/pixi-filters/filter-rgb-split.js')
.addIncludeFile('Extensions/Effects/rgb-split-pixi-filter.js');
const rgbSplitProperties = rgbSplitEffect.getProperties();
Expand Down Expand Up @@ -1218,6 +1227,7 @@ module.exports = {
.setFullName(_('Tilt shift'))
.setDescription(_('Render a tilt-shift-like camera effect.'))
.markAsOnlyWorkingFor2D()
.setHelpPath('/all-features/effects/tilt-split')
.addIncludeFile('Extensions/Effects/pixi-filters/filter-tilt-shift.js')
.addIncludeFile('Extensions/Effects/tilt-shift-pixi-filter.js');
const tiltShiftProperties = tiltShiftEffect.getProperties();
Expand Down
2 changes: 2 additions & 0 deletions newIDE/app/scripts/lib/ExtensionReferenceGenerator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1168,6 +1168,8 @@ const generateExtensionRawText = (
].join(' ');
}),
'',
effectMetadata.getHelpPath() ? generateReadMoreLink(effectMetadata.getHelpPath()) : '',
'',
].join(`\n`),
};
}
Expand Down
Loading