Giter Club home page Giter Club logo

sky-service's Introduction

sky-service

A basic package allowing for easy control over precipitation / lightning.

set up

Download from wally, then call:

SkyService.new()

After this is called it should be usable just by requiring the package anywhere.

configuration

ceiling detection

To determine whether to render precipitation it will shoot raycasts upwards from your position to try and find a ceiling.

local ceilingCastParams = RaycastParams.new()

SkyService.CoverageCheckDistance:Set(100) -- sets how far up it will check for a ceiling, in this case 100 units
SkyService.CoverageParams:Set(ceilingCastParams) -- sets the raycastParams for the raycasts

enable / disable

Should you want to pause the effects (like for say a loading screen / UI) you can do so:

SkyService.Enabled:Set(false) -- disables
SkyService.Enabled:Set(true) -- enables
local isEnabled = SkyService.Enabled:Get() -- retrieves current value

effects

For each effect you can pass a number from 0 to 1, with 1 being full throttle, and 0 basically turning it off

rain

Drops raindrop particles + plays sound + adds splash fx to the screen

SkyService.Rain:Set(1) -- full rain
SkyService.Rain:Set(0.5) -- light rain
SkyService.Rain:Set(0) -- no rain

snow

Drops snowflake particles

SkyService.Snow:Set(1) -- blizzard
SkyService.Snow:Set(0.5) -- gentle snow
SkyService.Snow:Set(0) -- no snow

lightning

Currently under repair and doesn't do anything.

sky-service's People

Contributors

nightcycle avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.