mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 14:01:37 +00:00
64 lines
1.8 KiB
YAML
64 lines
1.8 KiB
YAML
# This file is automatically generated. Please don't edit it manually.
|
|
# To submit a bug report on the content, see
|
|
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
|
|
|
name: PluginToolbar
|
|
type: class
|
|
memory_category: Instances
|
|
summary: ''
|
|
description: |
|
|
A `PluginToolbar` object is created by calling the
|
|
`Class.Plugin:CreateToolbar()` method and is used to contain
|
|
`Class.PluginToolbarButton|PluginToolbarButtons`.
|
|
code_samples: []
|
|
inherits:
|
|
- Instance
|
|
descendants: []
|
|
tags:
|
|
- NotCreatable
|
|
deprecation_message: ''
|
|
properties: []
|
|
methods:
|
|
- name: PluginToolbar:CreateButton
|
|
summary: |
|
|
Creates a `Class.PluginToolbarButton` that allows the user to initiate a
|
|
single, one-off action in Studio.
|
|
description: |
|
|
Creates a `Class.PluginToolbarButton` that allows the user to initiate a
|
|
single, one-off action in Studio through its
|
|
`Class.PluginToolbarButton.Click|Click` event.
|
|
code_samples:
|
|
- adding-a-plugin-toolbar-button
|
|
parameters:
|
|
- name: buttonId
|
|
type: string
|
|
default:
|
|
summary: |
|
|
A unique button ID.
|
|
- name: tooltip
|
|
type: string
|
|
default:
|
|
summary: |
|
|
The text displayed in the tooltip shown when a user hovers over the
|
|
button.
|
|
- name: iconname
|
|
type: string
|
|
default:
|
|
summary: |
|
|
The asset ID of the icon displayed in the button.
|
|
- name: text
|
|
type: string
|
|
default:
|
|
summary: |
|
|
Optional text displayed under the button icon.
|
|
returns:
|
|
- type: PluginToolbarButton
|
|
summary: |
|
|
The created `Class.PluginToolbarButton` instance.
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: PluginSecurity
|
|
thread_safety: Unsafe
|
|
capabilities: []
|
|
events: []
|
|
callbacks: []
|