@quenty/pillbacking

10.2.0 • Public • Published

PillBacking

Builds a pill backing for Guis. Substitute for UICorner object. Historically, this was created before the UICorner object was created. It still has utility in that it can provide a dropshadow to pill-based GUIs.

However, you should probably prefer to use a UICorner object instead of this package. This package is primarily published so legacy code may continue to rely upon it.

Installation

npm install @quenty/pillbacking --save

Usage

Usage is designed to be simple.

Builder API

PillBackingBuilder.new(options)

PillBackingBuilder:CreateSingle(gui, options)

PillBackingBuilder:Create(gui, options)

PillBackingBuilder:CreateVertical(gui, options)

PillBackingBuilder:CreateSingleShadow(gui, options)

PillBackingBuilder:CreateShadow(gui, options)

PillBackingBuilder:CreateCircle(gui, options)

PillBackingBuilder:CreateCircleShadow(gui, options)

PillBackingBuilder:CreateLeft(gui, options)

PillBackingBuilder:CreateRight(gui, options)

PillBackingBuilder:CreateTop(gui, options)

PillBackingBuilder:CreateBottom(gui, options)

Utils API

Utility functions to work with pillbackings. This can make animations a lot easier to work with.

PillBackingUtils.setBackgroundColor(backing, color3)

PillBackingUtils.setTransparency(backing, transparency)

PillBackingUtils.setShadowTransparency(shadow, transparency)

Package Sidebar

Install

npm i @quenty/pillbacking

Weekly Downloads

233

Version

10.2.0

License

MIT

Unpacked Size

23.5 kB

Total Files

8

Last publish

Collaborators

  • quenty