Data object storing the configuration for an individual fireworks display. More...
#include <FireworksLocationConfiguration.h>
Public Member Functions | |
| FireworksLocationConfiguration (Space::LatLong location, float chance, u32 startTimeHour, u32 endTimeHour) | |
| Create a FireworksLocationConfiguration with specified values. | |
| bool | IsAllDayFireworks () const |
| Is this fireworks display configuration configured to run all day? This is true if startTimeHour is equal to endTimeHour. | |
Public Attributes | |
| Space::LatLong | location |
| Latitude and Longitude of the position of the fireworks display in the world. | |
| float | chanceOfAppearing |
| Chance of the fireworks display appearing each time you visit the location. Valid range is 0 < X <= 1.0. | |
| u32 | startTimeHour |
| The start time in terms of hours on a 24-hour clock the fireworks will play. Valid range is 0 <= X <= 23. | |
| u32 | endTimeHour |
| The end time in terms of hours on a 24-hour clock the fireworks will end. Valid range is 0 <= X <= 23. If it matches startTimeHour, will play indefinitely. | |
| bool | loopDisplay |
| The fireworks display will loop the firework sequences when running if true. If false, it will display each sequence once then stop. | |
Data object storing the configuration for an individual fireworks display.
This type configures a potential fireworks displays settings, from where it's located to when it should play These should be added to a IFireworksLocationRepository or a FireworksModule in order to see the display in the world.
1.8.3.1
