Stay organized with collections
Save and categorize content based on your preferences.
blockly > Extensions > apply
Extensions.apply() function
Applies an extension method to a block. This should only be called during block construction.
Signature:
export declare function apply(name: string, block: Block, isMutator: boolean): void;
Parameters
Parameter |
Type |
Description |
name |
string |
The name of the extension. |
block |
Block |
The block to apply the named extension to. |
isMutator |
boolean |
True if this extension defines a mutator. |
Returns:
void
Exceptions
{Error} if the extension is not found.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eBlockly.Extensions.apply()\u003c/code\u003e function integrates an extension's functionality into a specific block during its creation.\u003c/p\u003e\n"],["\u003cp\u003eIt requires the extension's name, the target block, and a boolean indicating if the extension is a mutator.\u003c/p\u003e\n"],["\u003cp\u003eIf the specified extension isn't found, the function throws an error, ensuring proper handling during block construction.\u003c/p\u003e\n"]]],["The `Extensions.apply()` function applies a named extension to a specified block during its construction. It takes three parameters: the extension's name, the target block object, and a boolean indicating if the extension is a mutator. The function's purpose is to modify a block with a designated extension. It returns nothing and throws an error if the extension cannot be found.\n"],null,["[blockly](./blockly.md) \\\u003e [Extensions](./blockly.extensions_namespace.md) \\\u003e [apply](./blockly.extensions_namespace.apply_1_function.md)\n\nExtensions.apply() function\n---------------------------\n\nApplies an extension method to a block. This should only be called during block construction.\n\n**Signature:** \n\n export declare function apply(name: string, block: Block, isMutator: boolean): void;\n\nParameters\n----------\n\n| Parameter | Type | Description |\n|-----------|-----------------------------------|--------------------------------------------|\n| name | string | The name of the extension. |\n| block | [Block](./blockly.block_class.md) | The block to apply the named extension to. |\n| isMutator | boolean | True if this extension defines a mutator. |\n\n**Returns:**\n\nvoid\n\nExceptions\n----------\n\n{Error} if the extension is not found."]]