The state that this effect should be be in. This property is also automaticly fetched from effects/ .py if the file exists. the possible values are: None, True, False If this is not set: We simply assume that missing/none = True, an
(self)
| 89 | |
| 90 | @property |
| 91 | def activeByDefault(self): |
| 92 | """ |
| 93 | The state that this effect should be be in. |
| 94 | This property is also automaticly fetched from effects/<effectName>.py if the file exists. |
| 95 | the possible values are: |
| 96 | None, True, False |
| 97 | |
| 98 | If this is not set: |
| 99 | We simply assume that missing/none = True, and set it accordingly |
| 100 | (much as we set runTime to Normalif not otherwise set). |
| 101 | Nearly all effect files will fall under this category. |
| 102 | |
| 103 | If this is set to True: |
| 104 | We would enable it anyway, but hey, it's double enabled. |
| 105 | No effect files are currently configured this way (and probably will never be). |
| 106 | |
| 107 | If this is set to False: |
| 108 | Basically we simply skip adding the effect to the effect handler when the effect is called, |
| 109 | much as if the run time didn't match or other criteria failed. |
| 110 | """ |
| 111 | if not self.__generated: |
| 112 | self.__generateHandler() |
| 113 | |
| 114 | return self.__activeByDefault |
| 115 | |
| 116 | @activeByDefault.setter |
| 117 | def activeByDefault(self, value): |
nothing calls this directly
no test coverage detected