Skip to content

Commit f2a7d82

Browse files
committed
updated API docs based on comments in #284
1 parent 459820e commit f2a7d82

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/API-Reference.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -853,11 +853,18 @@ The refresh() function can be used to only reload the ScriptCraft plugin (it's l
853853

854854
1. Disable the ScriptCraft plugin.
855855
2. Unload all event listeners associated with the ScriptCraft plugin.
856+
3. Cancel all timed tasks (created by `setInterval` & `setTimeout`)
856857
3. Enable the ScriptCraft plugin.
857858

858859
... refresh() can be used during development to reload only scriptcraft javascript files.
859860
See [issue #69][issue69] for more information.
860861

862+
By default, if `self` is defined at runtime, it checks, whether `self` is server operator, otherwise fails with message. This behavivor can be modified using `skipOpCheck` parameter (useful, if you are doing some custom premission checks before calling this function).
863+
864+
#### Parameters
865+
866+
* skipOpCheck (boolean - optional) : If true, the function won't check if `self` is server operator.
867+
861868
[issue69]: https://github.com/walterhiggins/ScriptCraft/issues/69
862869

863870
### addUnloadHandler() function

0 commit comments

Comments
 (0)