HoshinoKoji/jsPsych
1
0
Fork 0
mirror of https://github.com/jspsych/jsPsych.git synced 2025-05-10 11:10:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

small update to info section

Browse Source
This commit is contained in:
Josh de Leeuw 2021-09-17 13:56:35 -04:00
parent af0dad88ec
commit c156bcc444
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/developers/plugin-development.md
View File

@ -69,11 +69,21 @@ If the `default` value is `undefined` then a user must specify a value for this
jsPsych allows most [plugin parameters to be dynamic](/overview/dynamic-parameters.md), which means that the parameter value can be a function that will be evaluated right before the trial starts. However, if you want your plugin to have a parameter that is a function that _shouldn't_ be evaluated before the trial starts, then you should make sure that the parameter type is `'FUNCTION'`. This tells jsPsych not to evaluate the function as it normally does for dynamic parameters. See the `canvas-*` plugins for examples. jsPsych allows most [plugin parameters to be dynamic](/overview/dynamic-parameters.md), which means that the parameter value can be a function that will be evaluated right before the trial starts. However, if you want your plugin to have a parameter that is a function that _shouldn't_ be evaluated before the trial starts, then you should make sure that the parameter type is `'FUNCTION'`. This tells jsPsych not to evaluate the function as it normally does for dynamic parameters. See the `canvas-*` plugins for examples.
The `info` object should be a `static` member of the class. The `info` object should be a `static` member of the class, as shown below.
```js ```js
const info = { const info = {
... name: 'my-awesome-plugin',
parameters: {
image: {
type: jspsych.ParameterType.IMAGE,
default: undefined
},
image_duration: {
type: jspsych.ParameterType.INT,
default: 500
}
}
} }
class MyAwesomePlugin { class MyAwesomePlugin {