Leahnaya/porymap
1
0
Fork 0
mirror of https://github.com/huderlem/porymap.git synced 2026-08-11 11:26:00 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add registerToggleAction

Browse Source
This commit is contained in:
GriffinR
2023-02-10 11:46:19 -05:00
parent bf0ec3395d
commit bc256053d0
5 changed files with 27 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docsrc/manual/scripting-capabilities.rst
View File

@@ -1406,6 +1406,15 @@ All utility functions are callable via the global ``utility`` object.
:param string actionName: name of the action that will be displayed in the ``Tools`` menu
:param string shortcut: optional keyboard shortcut
.. js:function:: utility.registerToggleAction(functionName, actionName, shortcut = "", checked = false)
Registers a JavaScript function to an action that can be manually triggered in Porymap's ``Tools`` menu. Optionally, a keyboard shortcut (e.g. ``"Ctrl+P"``) can also be specified, assuming it doesn't collide with any existing shortcuts used by Porymap. A check mark will be toggled next to the action name each time its activated. Whether the check mark is initially present can be set with ``checked``. The function specified by ``functionName`` must have the ``export`` keyword.
:param string functionName: name of the JavaScript function
:param string actionName: name of the action that will be displayed in the ``Tools`` menu
:param string shortcut: optional keyboard shortcut
:param boolean checked: whether the action initially has a check mark. Defaults to ``false``.
.. js:function:: utility.setTimeout(func, delayMs)
This behaves essentially the same as JavaScript's ``setTimeout()`` that is used in web browsers or NodeJS. The ``func`` argument is a JavaScript function (NOT the name of a function) which will be executed after a delay. This is useful for creating animations or refreshing the overlay at constant intervals.