snowstorm - pray for snow¶

# WT_SNOWSTORM PLUGIN #
includeLibs.user_wtsnowstorm = EXT:wt_snowstorm/class.tx_wtsnowstorm.php

# main settings
plugin.tx_wtsnowstorm = USER_INT
plugin.tx_wtsnowstorm {
        userFunc = tx_wtsnowstorm->start
        userFunc.settings {
                ### constants ###
                template.js = {$plugin.wtsnowstorm.template.js}
                startdate = {$plugin.wtsnowstorm.startdate}
                enddate = {$plugin.wtsnowstorm.enddate}
                periodical_mode = {$plugin.wtsnowstorm.periodical_mode}
                pid = {$plugin.wtsnowstorm.pid}
                excludeOnPid = {$plugin.wtsnowstorm.excludeOnPid}

                ### constants: JS Part ###
                flakesmax = {$plugin.wtsnowstorm.flakesmax}
                flakesmaxactive = {$plugin.wtsnowstorm.flakesmaxactive}
                animationInterval = {$plugin.wtsnowstorm.animationInterval}
                flakeBottom = {$plugin.wtsnowstorm.flakeBottom}
                targetElement = {$plugin.wtsnowstorm.targetElement}
                followMouse = {$plugin.wtsnowstorm.followMouse}
                snowColor = {$plugin.wtsnowstorm.snowColor}
                snowCharacter = {$plugin.wtsnowstorm.snowCharacter}
                snowStick = {$plugin.wtsnowstorm.snowStick}
                useMeltEffect = {$plugin.wtsnowstorm.useMeltEffect}
                useTwinkleEffect = {$plugin.wtsnowstorm.useTwinkleEffect}
                usePositionFixed = {$plugin.wtsnowstorm.usePositionFixed}
                flakeLeftOffset = {$plugin.wtsnowstorm.flakeLeftOffset}
                flakeRightOffset = {$plugin.wtsnowstorm.flakeRightOffset}
                flakeWidth = {$plugin.wtsnowstorm.flakeWidth}
                flakeHeight = {$plugin.wtsnowstorm.flakeHeight}
                vMaxX = {$plugin.wtsnowstorm.vMaxX}
                vMaxY = {$plugin.wtsnowstorm.vMaxY}
                zIndex = {$plugin.wtsnowstorm.zIndex}
        }
}

# TypeNum 3136 offers the dynamic snowstorm javascript
snowstorm = PAGE
snowstorm {
        typeNum = 3136
        10 < plugin.tx_wtsnowstorm

        config {
                disableAllHeaderCode = 1
                disablePrefixComment = 1
                xhtml_cleaning = 0
                admPanel = 0
        }
}

# Add javascript file to html header
page.headerData.3136 = TEXT
page.headerData.3136 {
    wrap = <script src="|" type="text/javascript"></script>
    typolink.parameter.data = page : uid
    typolink.additionalParams = &type=3136
    typolink.addQueryString = 1
    typolink.returnLast = url
}

###
# This are the default TS-constants for wt_snowstorm
##

plugin.wtsnowstorm {

        # cat=plugin.wtsnowstorm//0010; type=file[html,htm,tmpl,txt,js]; label= Javascript for snowstorm: JS-template file main snowstorm (see EXT:wt_snowstorm/files/js/snowstorm.js for an example)
        template.js = EXT:wt_snowstorm/files/js/snowstorm.js

        # cat=plugin.wtsnowstorm//0020; type=text; label= Startdate for snowstorm: Define a startdate for snowstorm javascript (like 01-11-2008)
        startdate = 01-11-2009

        # cat=plugin.wtsnowstorm//0030; type=text; label= Enddate for snowstorm: Define an enddate for snowstorm javascript (like 01-02-2009)
        enddate = 01-02-2010

        # cat=plugin.wtsnowstorm//0040; type=boolean; label= Periodical start and stop: Start and Stop every year on the same time (only month and day of start- and enddate will be used) (like 1)
        periodical_mode = 1

        # cat=plugin.wtsnowstorm//0050; type=text; label= Use in PID: Select in which PID snowstorm should work and define the treedepth (4,2 means that snowstorm works in pid 4 and 2 levels below that page - 1,250 means that snowstorm works in page 1 and invinite levels below - 0,250 means that snowstorm works in every page - 1,0 means that snowstorm works only in pid 1)
        pid = 0,99

        # cat=plugin.wtsnowstorm//0060; type=text; label= Exclude pages: Enter some PID on which no snow should fall from the sky - commaseparated list (e.g. 1,2,3,4)
        excludeOnPid =

        ### JS Part ###

        # cat=plugin.wtsnowstorm//0100; type=int+; label= JS Setting Flakesmax: Limit total amount of snow made (falling + sticking)
        flakesmax = 128

        # cat=plugin.wtsnowstorm//0110; type=int+; label= JS Setting Flakesmaxactive: Limit amount of snow falling at once (less = lower CPU use)
        flakesmaxactive = 64

        # cat=plugin.wtsnowstorm//0120; type=int+; label= JS Setting animationInterval: Theoretical "miliseconds per frame" measurement. 20 = fast + smooth, but high CPU use. 50 = more conservative, but slower
        animationInterval = 33

        # cat=plugin.wtsnowstorm//0130; type=int+; label= JS Setting flakeBottom: Integer for Y axis snow limit, 0 for "full-screen" snow effect
        flakeBottom = 0

        # cat=plugin.wtsnowstorm//0140; type=text; label= JS Setting targetElement: Element which snow will be appended to (document body if null/undefined) - can be an element ID string, or a DOM node reference
        targetElement = null

        # cat=plugin.wtsnowstorm//0150; type=options[true,false]; label= JS Setting followMouse: Snow will change movement with the user's mouse
        followMouse = true

        # cat=plugin.wtsnowstorm//0160; type=text; label= JS Setting snowcolor: Do not eat (or use?) yellow snow
        snowColor = #fff

        # cat=plugin.wtsnowstorm//0170; type=text; label= JS Setting snowCharacter: &bull[semicolon] = bullet, &middot[semicolon] is square on some systems etc
        snowCharacter = •

        # cat=plugin.wtsnowstorm//0190; type=options[true,false]; label= JS Setting snowStick: Whether or not snow should "stick" at the bottom. When off, will never collect
        snowStick = true

        # cat=plugin.wtsnowstorm//0200; type=options[true,false]; label= JS Setting useMeltEffect: When recycling fallen snow (or rarely, when falling), have it "melt" and fade out if browser supports it
        useMeltEffect = true

        # cat=plugin.wtsnowstorm//0210; type=options[true,false]; label= JS Setting useTwinkleEffect: Allow snow to randomly "flicker" in and out of view while falling
        useTwinkleEffect = false

        # cat=plugin.wtsnowstorm//0220; type=options[true,false]; label= JS Setting usePositionFixed: true = snow not affected by window scroll. may increase CPU load, disabled by default - if enabled, used only where supported
        usePositionFixed = false

        # cat=plugin.wtsnowstorm//0400; type=int+; label= JS Setting flakeLeftOffset: Amount to subtract from edges of container
        flakeLeftOffset = 0

        # cat=plugin.wtsnowstorm//0410; type=int+; label= JS Setting flakeRightOffset: Amount to subtract from edges of container
        flakeRightOffset = 0

        # cat=plugin.wtsnowstorm//0420; type=int+; label= JS Setting flakeWidth: Max pixel width for snow element
        flakeWidth = 8

        # cat=plugin.wtsnowstorm//0430; type=int+; label= JS Setting flakeHeight: Max pixel height for snow element
        flakeHeight = 8

        # cat=plugin.wtsnowstorm//0440; type=int+; label= JS Setting vMaxX: Maximum X velocity range for snow
        vMaxX = 5

        # cat=plugin.wtsnowstorm//0450; type=int+; label= JS Setting vMaxY: Maximum Y velocity range for snow
        vMaxY = 4

        # cat=plugin.wtsnowstorm//0460; type=int; label= JS Setting zIndex: CSS stacking order applied to each snowflake
        zIndex = 0

}