Skip to content

Commit 65f914e

Browse files
authored
In the toolbox, don't show mechanism methods that the user should not override: fire_event, register_event_handler, and unregister_event_handler. (#258)
1 parent e4c550c commit 65f914e

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

src/toolbox/methods_category.ts

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,21 +73,29 @@ class MethodsCategory {
7373
// TODO(lizlooney): We need a way to mark a method in python as not overridable.
7474
// For example, in RobotBase, define_hardware, register_event_handler,
7575
// unregister_event_handler, and fire_event should not be overridden in a user's robot.
76-
const methodNamesNotOverrideable: string[] = [
76+
const robotMethodNamesNotOverrideable: string[] = [
7777
'define_hardware',
7878
'fire_event',
7979
'register_event_handler',
8080
'unregister_event_handler',
8181
];
8282
// Add the methods for a Robot.
8383
this.addClassBlocksForCurrentModule(
84-
'More Robot Methods', this.robotClassBlocks, methodNamesNotOverrideable,
84+
'More Robot Methods', this.robotClassBlocks, robotMethodNamesNotOverrideable,
8585
methodNamesAlreadyOverridden, contents);
8686
break;
8787
case storageModule.ModuleType.MECHANISM:
88+
// TODO(lizlooney): We need a way to mark a method in python as not overridable.
89+
// For example, in Mechanism, register_event_handler, unregister_event_handler, and
90+
// fire_event should not be overridden in a user's mechamism.
91+
const mechanismMethodNamesNotOverrideable: string[] = [
92+
'fire_event',
93+
'register_event_handler',
94+
'unregister_event_handler',
95+
];
8896
// Add the methods for a Mechanism.
8997
this.addClassBlocksForCurrentModule(
90-
'More Mechanism Methods', this.mechanismClassBlocks, [],
98+
'More Mechanism Methods', this.mechanismClassBlocks, mechanismMethodNamesNotOverrideable,
9199
methodNamesAlreadyOverridden, contents);
92100
break;
93101
case storageModule.ModuleType.OPMODE:

0 commit comments

Comments
 (0)