17468 add warning to documentation about overriding custom script properties

This commit is contained in:
Arthur Hanson 2024-10-16 09:00:51 -07:00 committed by Jeremy Stretch
parent e7bd0e53d7
commit 35307d213f

View File

@ -72,6 +72,9 @@ script_order = (MyCustomScript, AnotherCustomScript)
Script attributes are defined under a class named `Meta` within the script. These are optional, but encouraged. Script attributes are defined under a class named `Meta` within the script. These are optional, but encouraged.
!!! warning
These are also defined and used as properties on the base custom script class, so don't use the same names as variables or override them in your custom script.
### `name` ### `name`
This is the human-friendly names of your script. If omitted, the class name will be used. This is the human-friendly names of your script. If omitted, the class name will be used.