# 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: PluginAction
type: class
memory_category: Instances
summary: ''
description: |
  `PluginAction` represents a generic performable action in Studio with no
  directly‑associated `Class.PluginToolbarButton`. If
  `Class.PluginAction.AllowBinding|AllowBinding` is `true`, the action can be
  assigned a keyboard shortcut through Studio's **File** ⟩ **Customize
  Shortcuts** window.

  A `PluginAction` must be created using the `Class.Plugin:CreatePluginAction()`
  method in order to work as expected.
code_samples: []
inherits:
  - Instance
descendants: []
tags:
  - NotReplicated
deprecation_message: ''
properties:
  - name: PluginAction.ActionId
    summary: |
      A string that uniquely identifies this action.
    description: |
      A string that uniquely identifies this action. This string is the key used
      when saving and loading the action's state in Roblox Studio.
    code_samples: []
    type: string
    tags:
      - ReadOnly
      - NotReplicated
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Data
    serialization:
      can_load: false
      can_save: false
    capabilities: []
  - name: PluginAction.AllowBinding
    summary: |
      Determines whether the action can be assigned a keyboard shortcut in
      Studio.
    description: |
      This property determines whether the action can be assigned a keyboard
      shortcut through Studio's **File** ⟩ **Customize Shortcuts** window.
      Default is `true`.
    code_samples: []
    type: boolean
    tags:
      - ReadOnly
      - NotReplicated
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Data
    serialization:
      can_load: false
      can_save: false
    capabilities: []
  - name: PluginAction.StatusTip
    summary: |
      The description of the action when viewing it from the keyboard shortcuts
      window in Roblox Studio.
    description: |
      The description of the action when viewing it from the keyboard shortcuts
      window in Roblox Studio.
    code_samples: []
    type: string
    tags:
      - ReadOnly
      - NotReplicated
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Data
    serialization:
      can_load: false
      can_save: false
    capabilities: []
  - name: PluginAction.Text
    summary: |
      The text that is displayed when viewing this action in Roblox Studio.
    description: |
      The text that is displayed when viewing this action in Roblox Studio.
    code_samples: []
    type: string
    tags:
      - NotReplicated
    deprecation_message: ''
    security:
      read: None
      write: RobloxScriptSecurity
    thread_safety: ReadSafe
    category: Data
    serialization:
      can_load: true
      can_save: false
    capabilities: []
methods: []
events:
  - name: PluginAction.Triggered
    summary: |
      Fires when the action is triggered.
    description: |
      Fires when the action is triggered, typically through the keyboard
      shortcut that it was bound to.
    code_samples: []
    parameters: []
    tags: []
    deprecation_message: ''
    security: PluginSecurity
    capabilities: []
callbacks: []