Documentation/  

Holiday

This documentation has been moved to https://help.themehouse.com/docs/holidays/getting-started-with-holidays

Holiday Options

Enable automatic holiday selection - This setting will attempt to select the correct holiday styling to apply, if this is not selected the current holiday styling will need to be selected with the option below.

Current holiday - This setting allows you to select any holidays that have been created, if you set this while having the option above enabled it will likely be overwritten.

Winter/Snow Based Holiday

Title - This setting allows you to set a title for the custom holiday.

Priority - This setting allows you to set the priority for this holiday as depending on how low the number will depend which holiday shows first on your forum based on the automatic holiday selection.

Start date - Date used when the holiday starts.

End date - Date used when the holiday ends.

Calculate start/end date with callback - This setting allows you to use a custom callback which will be used when automation calculates the start/end dates.

Css_template - Use your own css template if you’d like for different holidays.

Options - These options allow you to enable/disable the holiday and the snow effect.

Snowflake character - Choose what snow flake character you’d like to use based on the special characters.

Minimum snowflakes - Choose what the minimum amount of snowflakes should be.

Snowflakes - Choose how many snowflakes you want your forum users to see falling down on the screen.

Maximum snow flakes - Choose what the maximum amount of snowflakes should be.

New Years Based Holiday

Start after x seconds - This setting allows you to start the fireworks after a number of seconds. By default the fireworks will start after the forum's index is refreshed.

End after x seconds - This setting allows you to end the fire works after a number of seconds. By default the fireworks will end after five seconds.

Firework acceleration - This setting allows you to accelerate or deaccelerate the bursting of the fireworks. If it is brought down the fireworks will then be delayed if brought down or sped up if brought up.

Firework brightness minimum - This setting allows you to set the minimum brightness for all of the fireworks that burst on your forum's index. This is synced along with the other setting below it which sets the maximum brightness as well.

Firework brightness maximum - This setting allows you to set the maximum brightness for all of the fireworks that birst on your forum's index. This is synced along with the other setting above it which sets the minimum brightness as well.

Firework Speed - This setting allows you to set the speed of the firework which is then shown on your forum's index.

Firework trail length - This setting allows you to set the fireworks tail length which is seen before the firework explodes.

Firework target indicator - When this option is ticked, you will see a circular based target indicator to show where the firework is gonna explode on the forum index. When it is unticked, you will just have to watch and see where the firework explodes.

Particle brightness minimum - This setting allows you to set the minimum brightness for the particle burst, this also relates to the fireworks brightness as well as it works the same way. This is synced along with the other setting below it which sets the maximum brightness as well.

Particle brightness maximum - This setting allows you to set the maximum brightness for the particle burst, this also relates to the fireworks brightness as well as it works the same way. This is synced along with the other setting above it which sets the maximum brightness as well.

Particle count - This setting allows you to set a custom number of particles which are seen during the firework bursts.

Particle decay minimum - This setting allows you to set the minimum decay amount for firework bursts. This is synced along with the other setting below it which sets the maximum particle decay.

Particle decay maximum - This setting allows you to set the maximum decay amount for firework bursts. This is synced along with the other setting above it which sets the minimum particle decay.

Particle friction - This setting allows you to add friction or de-add friction between the fireworks which collide with each other when passing or exploding.

Particle gravity - This setting allows you to add gravity or de-add gravity between the fireworks when they launch or explode.

Particle hue variance - This setting allows you to change the hue variance which changes the variance in colors which can be viewed on the fireworks.

Particle transperancy - This setting allows you to add transperancy to the fireworks burst and tail depending on how high/low the setting it set to.

Particle speed minimum - This setting allows you to change the minimum particle speed which is used when the firework is launched on your forums index.

Particle speed maximum - This setting allows you to change the maximum particle speed which is used when the firework is launched on your forums index.

Particle trail length - This setting allows you to set the fireworks trail length which is shown before the firework burts.

Copyright © 2024 Audentio, LLC. All Rights Reserved.