blockly > Block > renameVarById
Block.renameVarById() method
Notification that a variable is renaming. If the ID matches one of this block's variables, rename it.
Signature:
renameVarById(oldId: string, newId: string): void;
Parameters
| Parameter |
Type |
Description |
| oldId |
string |
ID of variable to rename. |
| newId |
string |
ID of new variable. May be the same as oldId, but with an updated name. |
Returns:
void
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["The `renameVarById` method updates a block's variable references when a variable is renamed."],["It accepts the old and new IDs of the variable, renaming the variable within the block if it's used by the block."],["This method is triggered by variable renaming events and ensures the block's internal references are consistent with the updated variable name."]]],["The `renameVarById` method within the `Block` class handles variable renaming. It checks if a provided `oldId` matches any of the block's variable IDs. If a match is found, the variable's ID is updated to the provided `newId`. The method takes two string parameters: `oldId` (the original ID) and `newId` (the updated ID) and does not return any value. This method ensures variable consistency across the block during a rename operation.\n"]]
