#plugins.core.accessibility

Accessibility Plugin.

#Submodules

#API Overview

Constants - Useful values which cannot be changed

Variables - Configurable values

Functions - API calls offered directly by the extension

#API Documentation

#Constants

Signatureplugins.core.accessibility.enabled <cp.prop: boolean; read-only>
TypeConstant
DescriptionIs true if Accessibility permissions have been enabled for CommandPost.
NotesNone
Sourcesrc/plugins/core/accessibility/accessibility.lua line 27

#Variables

Signatureplugins.core.accessibility.shouldWeTryCloseSystemPreferences -> boolean
TypeVariable
DescriptionShould we try and close system preferences?
NotesNone
Sourcesrc/plugins/core/accessibility/accessibility.lua line 17
Signatureplugins.core.accessibility.systemPreferencesAlreadyOpen -> boolean
TypeVariable
DescriptionWas System Preferences already open?
NotesNone
Sourcesrc/plugins/core/accessibility/accessibility.lua line 22

#Functions

Signatureplugins.core.accessibility.completeSetupPanel() -> none
TypeFunction
DescriptionCalled when the setup panel for accessibility was shown and is ready to complete.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/core/accessibility/accessibility.lua line 54
Signatureplugins.core.accessibility.init(setup) -> table
TypeFunction
DescriptionInitialises the module.
Parameters
  • setup - Dependancies setup
Returns
  • The module as a table
NotesNone
ExamplesNone
Sourcesrc/plugins/core/accessibility/accessibility.lua line 85
Signatureplugins.core.accessibility.showSetupPanel() -> none
TypeFunction
DescriptionCalled when the Setup Panel should be shown to prompt the user about enabling Accessbility.
Parameters
  • None
Returns
  • None
NotesNone
ExamplesNone
Sourcesrc/plugins/core/accessibility/accessibility.lua line 70

© Copyright 2024 LateNite Films Pty Ltd. All rights reserved.