671
edits
Modding:Active Parts: Difference between revisions
Jump to navigation
Jump to search
m
close paren
(update for power load functionality support, added and removed parts) |
m (close paren) |
||
| Line 702: | Line 702: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Returns a value intended to be used as a performance bonus based on power load, integrating with IsPowerLoadSensitive and ModOverloaded (and any other future features which may modify power load level). When the Load argument is set to the default int.MinValue, the current power load level will be automatically calculated and used, otherwise the level specified will be used (this is supported so that an already known level may be sent, for efficiency). The return value is ((WorkingLoadValue - Baseline) / Divisor). With IsPowerLoadSensitive set to true and ModOverloaded present, the return value of this method will be 2 (because ModOverloaded increases the power load value from 100 to 400, so ((400 - 100) / 150) = 2. Different Divisor numbers are typically used with different applications depending on what performance characteristics are desired. If IsPowerLoadSensitive is false, this method will return 0. | Returns a value intended to be used as a performance bonus based on power load, integrating with IsPowerLoadSensitive and ModOverloaded (and any other future features which may modify power load level). When the Load argument is set to the default int.MinValue, the current power load level will be automatically calculated and used, otherwise the level specified will be used (this is supported so that an already known level may be sent, for efficiency). The return value is ((WorkingLoadValue - Baseline) / Divisor). With IsPowerLoadSensitive set to true and ModOverloaded present, the return value of this method will be 2 (because ModOverloaded increases the power load value from 100 to 400, so ((400 - 100) / 150) = 2). Different Divisor numbers are typically used with different applications depending on what performance characteristics are desired. If IsPowerLoadSensitive is false, this method will return 0. | ||
This method is an overload of the same method present in the base <code>IPart</code>, which normally returns values based on similar logic (without sensitivity to any configuration value like IsPowerLoadSensitive, since <code>IPart</code> has nothing similar). | This method is an overload of the same method present in the base <code>IPart</code>, which normally returns values based on similar logic (without sensitivity to any configuration value like IsPowerLoadSensitive, since <code>IPart</code> has nothing similar). | ||