{"id":"octale/tokeru","name":"tokeru","scope":"octale","platform":"roblox","description":"Fading effect for technically everything","version":"0.0.5","latest":"0.0.5","versions":["0.0.1","0.0.2","0.0.3","0.0.4","0.0.5"],"license":"MIT","licenseRating":"safe","licenseCaveats":[],"licenseVerified":true,"dependencies":{},"integrity":"ea23d1f3ec0bfac7417fe8e64fdbc54df03eb5f84ab1224c0b9b462703753f6f","likes":0,"downloads":0,"install":"forest install octale/tokeru","url":"https://forest.dev/p/roblox/octale/tokeru","files":"https://api.forest.dev/ai/package/roblox/octale/tokeru/files","readme":"# tokeru\nFading as simple as ABC\n\n## Introduction\n\ntokeru (溶ける) is the Japanese word for dissolve. Filmmakers use the term dissolve to describe the transition that involves either fade in or fade out. That's the meaning of the name of this project.\n\nStart fine-tuning your UI with tokeru, rather than having UI appears instantly, have them appear with an animation instead! Aside from that, you can also combine tokeru with tweens/springs to build much amazing transitions, such as fade and scale up.\n\ntokeru is also capable of doing fade effects on other instances, such as: `BasePart`, `Sound`, `Decal`, `Texture`, et cetera, basically anything that has a Transparency modifier in it.\n\n## API Reference\n\n### tokeru\n**tokeru(mono, direction, duration: number) -> tokeruTweens**\n\nApply the fading effect to a `Mono` (object), see the method below on how to create a `Mono`. For direction, use either `tokeru[\"in\"]`, or `tokeru[\"out\"]`, in means fade in, out means fade out. Duration is the time taken for tokeru to fade.\n\n**tokeru.newMono(objects: {Instance}) -> mono**\n\nCreates a new `Mono` (object) for tokeru, used for fading.\n\n**tokeru[\"in\"]**\n\nA symbol, represents fade in.\n\n**tokeru[\"out\"]**\n\nA symbol, represents fade out.\n\n### tokeruTweens\n**tokeruTweens:Connect(fun: function))**\n\nFires the defined function when the tokeru effect is completed.\n\n**tokeruTweens:Wait(duration: number?)**\n\nHalts the code until the tokeru effect is completed, the optional duration parameter is if you want to wait a bit more after completion.\n\n**tokeruTweens:Pause()**\n\nPauses the tokeru effect.\n\n**tokeruTweens:Resume()**\n\nResumes the tokeru effect.\n\n**tokeruTweens:Cancel()**\n\nCancels the tokeru effect.\n\n**tokeruTweens:Destroy()**\n\nDestroys the tokeru effect, similar to `tokeruTweens:Cancel()`\n\n## Example\n\n**Code**\n\n```lua\nlocal ReplicatedStorage = game:GetService(\"ReplicatedStorage\")\n\nlocal Packages = ReplicatedStorage.Packages\nlocal tokeru = require(Packages.tokeru)\n\nlocal mono = tokeru.newMono({workspace})\n\nwait(2.4)\ntokeru(mono, tokeru.out, 0.6):Wait(1.2) -- fade out, 1.2s, wait for completion and wait 1.2 seconds\ntokeru(mono, tokeru[\"in\"], 0.6) -- fade in, 0.6s\n```\n\n**Video**\n\nhttps://user-images.githubusercontent.com/91356714/140732444-cee1ad47-af32-4e5a-a092-5d0b49426aa6.mov\n\n*thanks 7kayoh*\n\n## Installation\n\ntokeru can be installed with Wally, simply add tokeru in your Wally configuration for the project.\n\n```toml\ntokeru = \"octale/tokeru@0.0.2\"\n```\n\n## License\n\ntokeru is licensed under MIT license\n","readmeTruncated":false}