Function default

Returns {
    initialize(options?) => void;
}

• initialize:function

  • initialize(options?): void

  • Parameters

    • Optional options: {
          handleNameChange?: ((onChange) => unknown);
          local?: boolean;
          nameplatePositionHeightOptions?: NameplatePositionHeightOptions;
          textTextureOptions?: TextTextureOptions;
      }

      • Optional handleNameChange?: ((onChange) => unknown)

        • • (onChange): unknown

          • name change handler

            Parameters

            • onChange: ((name) => unknown)

              called on name change

              • • (name): unknown

                • Parameters

                  • name: string

                  Returns unknown

            Returns unknown

            Example

            verseModule.initialize(nameplate, {
              handleNameChange: (onChange) => {
                $input.addEventListener("change", (e) => {
                  onChange($input.value.trim());
                });
              },
            });
            Copy

      • Optional local?: boolean

        displays local player's nameplate

        Default

        true
        Copy

      • Optional nameplatePositionHeightOptions?: NameplatePositionHeightOptions

        nameplate position height options

      • Optional textTextureOptions?: TextTextureOptions

        nameplate texture options

    Returns void