Skip to content

Adding context through Help button #8556

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

Open
LuniMoon wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Adding context through Help button #8556

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b7ee298
Adding context through copy
LuniMoon Apr 30, 2026
38370e6
About Events destination
LuniMoon Apr 30, 2026
411b42a
Fix unused imports and variables causing linting failure
LuniMoon May 4, 2026
a7e4367
Make scopeName prop translatable in ExtensionDetailPanel help button
LuniMoon May 4, 2026
b6909a9
Reverting to contextual "About this action/condition"
LuniMoon May 4, 2026
eab1d2b
Signaling/fixing broken links
LuniMoon May 4, 2026
4a988f2
Contextual button - Objects
LuniMoon May 5, 2026
2573d91
Replace helpPath
LuniMoon May 6, 2026
458abe7
Replacing absolute URLs
LuniMoon May 6, 2026
028c196
Merge branch 'In-app-Help-management' of https://github.com/4ian/GDev…
LuniMoon May 6, 2026
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
14 changes: 7 additions & 7 deletions Core/GDCore/Extensions/Builtin/AdvancedExtension.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsAdvancedExtension(
"",
"res/functions/expression_black.svg",
"res/functions/expression_black.svg")
.SetHelpPath("/events/functions/return")
.SetHelpPath("events/functions/#return-a-value-from-a-function")
.AddParameter("expression", _("The number to be returned"))
.SetRelevantForFunctionEventsOnly()
.MarkAsAdvanced();
Expand All @@ -48,7 +48,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsAdvancedExtension(
"",
"res/functions/expression_black.svg",
"res/functions/expression_black.svg")
.SetHelpPath("/events/functions/return")
.SetHelpPath("/all-features/advanced/reference/#actions")
.AddParameter("string", _("The text to be returned"))
.SetRelevantForFunctionEventsOnly()
.MarkAsAdvanced();
Expand All @@ -62,7 +62,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsAdvancedExtension(
"",
"res/functions/condition_black.svg",
"res/functions/condition_black.svg")
.SetHelpPath("/events/functions/return")
.SetHelpPath("/all-features/advanced/reference/#actions")
.AddParameter("trueorfalse", _("Should the condition be true or false?"))
.SetRelevantForFunctionEventsOnly()
.MarkAsAdvanced();
Expand All @@ -77,7 +77,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsAdvancedExtension(
"",
"res/functions/extension_black.svg",
"res/functions/extension_black.svg")
.SetHelpPath("/events/functions/return")
.SetHelpPath("/all-features/advanced/reference/#actions")
.AddParameter("functionParameterName", _("Parameter name"), "variable")
.AddParameter("scenevar", _("Scene variable"))
.SetHidden()
Expand All @@ -92,7 +92,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsAdvancedExtension(
"",
"res/functions/extension_black.svg",
"res/functions/extension_black.svg")
.SetHelpPath("/events/functions/return")
.SetHelpPath("/all-features/advanced/reference/#actions")
.AddParameter("functionParameterName", _("Parameter name"), "variable")
.AddParameter("variable", _("Variable"))
.SetRelevantForFunctionEventsOnly()
Expand All @@ -108,7 +108,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsAdvancedExtension(
"",
"res/functions/extension_black.svg",
"res/functions/extension_black.svg")
.SetHelpPath("/events/functions/return")
.SetHelpPath("/all-features/advanced/reference/#actions")
.AddParameter("functionParameterName", _("Parameter name"), "variable")
.AddParameter("scenevar", _("Scene variable"))
.SetHidden()
Expand All @@ -123,7 +123,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsAdvancedExtension(
"",
"res/functions/extension_black.svg",
"res/functions/extension_black.svg")
.SetHelpPath("/events/functions/return")
.SetHelpPath("/all-features/advanced/reference/#actions")
.AddParameter("functionParameterName", _("Parameter name"), "variable")
.AddParameter("variable", _("Variable"))
.SetRelevantForFunctionEventsOnly()
Expand Down
12 changes: 6 additions & 6 deletions Core/GDCore/Extensions/Builtin/MathematicalToolsExtension.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ BuiltinExtensionsImplementer::ImplementsMathematicalToolsExtension(
_("Random integer"),
"",
"res/dice-6.svg")
.SetHelpPath("/all-features/expressions")
.SetHelpPath("/events/expressions/#expressions")
.AddParameter("expression", _("Maximum value"));

extension
Expand All @@ -37,7 +37,7 @@ BuiltinExtensionsImplementer::ImplementsMathematicalToolsExtension(
_("Random integer in range"),
"",
"res/dice-6.svg")
.SetHelpPath("/all-features/expressions")
.SetHelpPath("/events/expressions/#expressions")
.AddParameter("expression", _("Minimum value"))
.AddParameter("expression", _("Maximum value"));

Expand All @@ -47,7 +47,7 @@ BuiltinExtensionsImplementer::ImplementsMathematicalToolsExtension(
_("Random float"),
"",
"res/dice-6.svg")
.SetHelpPath("/all-features/expressions")
.SetHelpPath("/events/expressions/#expressions")
.AddParameter("expression", _("Maximum value"));

extension
Expand All @@ -56,7 +56,7 @@ BuiltinExtensionsImplementer::ImplementsMathematicalToolsExtension(
_("Random float in range"),
"",
"res/dice-6.svg")
.SetHelpPath("/all-features/expressions")
.SetHelpPath("/events/expressions/#expressions")
.AddParameter("expression", _("Minimum value"))
.AddParameter("expression", _("Maximum value"));

Expand All @@ -66,7 +66,7 @@ BuiltinExtensionsImplementer::ImplementsMathematicalToolsExtension(
_("Random value in steps"),
"",
"res/dice-6.svg")
.SetHelpPath("/all-features/expressions")
.SetHelpPath("/events/expressions/#expressions")
.AddParameter("expression", _("Minimum value"))
.AddParameter("expression", _("Maximum value"))
.AddParameter("expression", _("Step"));
Expand Down Expand Up @@ -476,7 +476,7 @@ BuiltinExtensionsImplementer::ImplementsMathematicalToolsExtension(
_("The number Pi (3.1415...)"),
"",
"res/mathfunction.png")
.SetHelpPath("/all-features/expressions");
.SetHelpPath("/events/expressions/#expressions");

extension
.AddExpression("lerpAngle",
Expand Down
20 changes: 10 additions & 10 deletions Core/GDCore/Extensions/Builtin/SceneExtension.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsSceneExtension(
"",
"res/conditions/depart24.png",
"res/conditions/depart.png")
.SetHelpPath("/interface/scene-editor/events")
.SetHelpPath("/interface/events-editor/")
Copy link
Copy Markdown
Collaborator

@D8H D8H May 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems that the old link was dead. Should we add a redirection?

Copy link
Copy Markdown
Collaborator Author

@LuniMoon LuniMoon May 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that would be a good idea?

.AddCodeOnlyParameter("currentScene", "")
.MarkAsSimple();

Expand All @@ -60,7 +60,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsSceneExtension(
"",
"res/conditions/depart24.png",
"res/conditions/depart.png")
.SetHelpPath("/interface/scene-editor/events")
.SetHelpPath("/interface/events-editor/")
.AddCodeOnlyParameter("currentScene", "")
.MarkAsSimple();

Expand All @@ -72,7 +72,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsSceneExtension(
"",
"res/actions/texte.png",
"res/actions/texte.png")
.SetHelpPath("/interface/scene-editor/events")
.SetHelpPath("/interface/events-editor/")
.AddCodeOnlyParameter("currentScene", "")
.AddParameter("sceneName", _("Name of the scene to check"))
.MarkAsSimple();
Expand All @@ -85,7 +85,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsSceneExtension(
"",
"res/actions/replaceScene24.png",
"res/actions/replaceScene.png")
.SetHelpPath("/interface/scene-editor/events")
.SetHelpPath("/interface/events-editor/")
.AddCodeOnlyParameter("currentScene", "")
.AddParameter("sceneName", _("Name of the new scene"))
.AddParameter("yesorno", _("Stop any other paused scenes?"))
Expand All @@ -102,7 +102,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsSceneExtension(
"",
"res/actions/pushScene24.png",
"res/actions/pushScene.png")
.SetHelpPath("/interface/scene-editor/events")
.SetHelpPath("/interface/events-editor/")
.AddCodeOnlyParameter("currentScene", "")
.AddParameter("sceneName", _("Name of the new scene"))
.MarkAsAdvanced();
Expand All @@ -117,7 +117,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsSceneExtension(
"",
"res/actions/popScene24.png",
"res/actions/popScene.png")
.SetHelpPath("/interface/scene-editor/events")
.SetHelpPath("/interface/events-editor/")
.AddCodeOnlyParameter("currentScene", "")
.MarkAsAdvanced();

Expand All @@ -129,7 +129,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsSceneExtension(
"",
"res/actions/quit24.png",
"res/actions/quit.png")
.SetHelpPath("/interface/scene-editor/events")
.SetHelpPath("/interface/events-editor/")
.AddCodeOnlyParameter("currentScene", "")
.MarkAsAdvanced();

Expand All @@ -141,7 +141,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsSceneExtension(
"",
"res/actions/background24.png",
"res/actions/background.png")
.SetHelpPath("/interface/scene-editor/events")
.SetHelpPath("/interface/events-editor/")
.AddCodeOnlyParameter("currentScene", "")
.AddParameter("color", _("Color"))
.MarkAsAdvanced();
Expand All @@ -155,7 +155,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsSceneExtension(
"",
"res/actions/window24.png",
"res/actions/window.png")
.SetHelpPath("/interface/scene-editor/events")
.SetHelpPath("/interface/events-editor/")
.AddCodeOnlyParameter("currentScene", "")
.AddParameter("yesorno", _("Deactivate input when focus is lost"))
.MarkAsAdvanced();
Expand All @@ -171,7 +171,7 @@ void GD_CORE_API BuiltinExtensionsImplementer::ImplementsSceneExtension(
"",
"res/actions/window24.png",
"res/actions/window.png")
.SetHelpPath("/interface/scene-editor/events")
.SetHelpPath("/interface/events-editor/")
.AddCodeOnlyParameter("currentScene", "");

extension
Expand Down
1 change: 1 addition & 0 deletions newIDE/app/src/AssetStore/ExtensionStore/ExtensionDetailPanel.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,7 @@ const ExtensionDetailPanel = ({
<HelpButton
key="help-button"
helpPagePath={extensionHeader.helpPath}
scopeName={t`Extension`}
/>
)}
{shouldDisplayButtons && isAlreadyInstalled && (
Expand Down
1 change: 1 addition & 0 deletions newIDE/app/src/AssetStore/ExtensionStore/ExtensionInstallDialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ const ExtensionInstallDialog = ({
<HelpButton
key="help-button"
helpPagePath={extensionHeader.helpPath}
scopeName="Extension"
/>
) : (
undefined
Expand Down
6 changes: 5 additions & 1 deletion newIDE/app/src/AssetStore/ExtensionStore/ExtensionsSearchDialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,11 @@ const ExtensionsSearchDialog = ({
/>,
]}
secondaryActions={[
<HelpButton key="help" helpPagePath="/extensions/search" />,
<HelpButton
key="help"
helpPagePath="/extensions/search"
scopeName="Extensions"
/>,
eventsFunctionsExtensionOpener ? (
<FlatButton
leftIcon={<Download />}
Expand Down
6 changes: 5 additions & 1 deletion newIDE/app/src/AssetStore/NewObjectDialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,7 +544,11 @@ function NewObjectDialog({
<Dialog
title={<Trans>New object</Trans>}
secondaryActions={[
<HelpButton helpPagePath="/objects" key="help" />,
<HelpButton
helpPagePath="/objects"
key="help"
scopeName="Objects"
/>,
]}
actions={[
<FlatButton
Expand Down
6 changes: 5 additions & 1 deletion newIDE/app/src/BehaviorsEditor/NewBehaviorDialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,11 @@ export default function NewBehaviorDialog({
/>,
]}
secondaryActions={[
<HelpButton helpPagePath="/behaviors" key="help" />,
<HelpButton
helpPagePath="/behaviors"
key="help"
scopeName="Behaviors"
/>,
]}
open
onRequestClose={onClose}
Expand Down
5 changes: 4 additions & 1 deletion newIDE/app/src/Debugger/DebuggerContent.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,10 @@ export default class DebuggerContent extends React.Component<Props, State> {
</ScrollView>
<MiniToolbar>
<Line justifyContent="space-between" alignItems="center" noMargin>
<HelpButton helpPagePath="/interface/debugger" />
<HelpButton
helpPagePath="/interface/debugger"
scopeName="Debugger"
/>
<div>
<Checkbox
checkedIcon={<Flash />}
Expand Down
1 change: 1 addition & 0 deletions newIDE/app/src/EventsFunctionsExtensionEditor/BehaviorMethodSelectorDialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ export default function BehaviorMethodSelectorDialog({
<HelpButton
key="help"
helpPagePath="/behaviors/events-based-behaviors"
scopeName="Behaviors"
/>,
]}
actions={[
Expand Down
1 change: 1 addition & 0 deletions ...tsFunctionsExtensionEditor/EventsBasedBehaviorOrObjectEditor/EventsBasedBehaviorEditor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,7 @@ export default function EventsBasedBehaviorEditor({
<HelpButton
key="help"
helpPagePath="/behaviors/events-based-behaviors"
scopeName="Behaviors"
/>
</Line>
</ColumnStackLayout>
Expand Down
1 change: 1 addition & 0 deletions ...entsFunctionsExtensionEditor/EventsBasedBehaviorOrObjectEditor/EventsBasedObjectEditor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,7 @@ export default function EventsBasedObjectEditor({
<HelpButton
key="help"
helpPagePath="/objects/custom-objects-prefab-template"
scopeName="Custom objects"
/>
</Line>
</ColumnStackLayout>
Expand Down
1 change: 1 addition & 0 deletions newIDE/app/src/EventsFunctionsExtensionEditor/EventsBasedObjectSelectorDialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ export default function EventsBasedObjectSelectorDialog({
<HelpButton
key="help"
helpPagePath="/objects/custom-objects-prefab-template"
scopeName="Custom objects"
/>,
]}
open
Expand Down
6 changes: 5 additions & 1 deletion newIDE/app/src/EventsFunctionsExtensionEditor/ExtensionFunctionSelectorDialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,11 @@ export default function ExtensionFunctionSelectorDialog({
/>,
]}
secondaryActions={[
<HelpButton key="help" helpPagePath="/events/functions" />,
<HelpButton
key="help"
helpPagePath="/events/functions"
scopeName="Functions"
/>,
]}
open
onRequestClose={onCancel}
Expand Down
4 changes: 2 additions & 2 deletions newIDE/app/src/EventsFunctionsExtensionEditor/ObjectMethodSelectorDialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ export default function ObjectMethodSelectorDialog({
secondaryActions={[
<HelpButton
key="help"
// TODO EBO Replace it with a new page about objects.
helpPagePath="/behaviors/events-based-behaviors"
helpPagePath="/objects/custom-objects-prefab-template"
scopeName="Object functions"
/>,
]}
actions={[
Expand Down
6 changes: 5 additions & 1 deletion newIDE/app/src/EventsFunctionsExtensionEditor/OptionsEditorDialog/ExtensionExporterDialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,11 @@ const ExtensionExporterDialog = (props: Props): React.Node => {
<Dialog
title={<Trans>Export extension</Trans>}
secondaryActions={[
<HelpButton key="help" helpPagePath="/extensions/share-extension/" />,
<HelpButton
key="help"
helpPagePath="/extensions/share-extension/"
scopeName="Extensions"
/>,
<FlatButton
label={
isFromTheStore ? (
Expand Down
6 changes: 5 additions & 1 deletion newIDE/app/src/EventsFunctionsExtensionEditor/OptionsEditorDialog/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,11 @@ export default function OptionsEditorDialog({
<Dialog
title={<Trans>{eventsFunctionsExtension.getName()} options</Trans>}
secondaryActions={[
<HelpButton key="help" helpPagePath="/extensions/create" />,
<HelpButton
key="help"
helpPagePath="/extensions/create"
scopeName="Extensions"
/>,
eventsFunctionsExtensionWriter ? (
<FlatButton
leftIcon={<Upload />}
Expand Down
1 change: 1 addition & 0 deletions newIDE/app/src/EventsSheet/EventsFunctionExtractor/EventsFunctionExtractorDialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ export default class EventsFunctionExtractorDialog extends React.Component<
<HelpButton
helpPagePath="/events/functions/extract-events"
key="help"
scopeName="Extract to function"
/>,
]}
actions={[
Expand Down
Loading
Loading