Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 1.74 KB

README.md

File metadata and controls

55 lines (35 loc) · 1.74 KB

ComplexRegions

CI Docs

This is a package that allows you to define regions in an experience out of BaseParts of any shape or size.

A character within a region composed of rectangles and a sphere

Usage

local region = ComplexRegions.createRegion(workspace.Region, {
    Players.LocalPlayer.Character
})

region.entered:Connect(function(instance: Instance)
    print(instance, "entered the region")
end)

region.left:Connect(function(instance: Instance)
    print(instance, "left the region")
end)

Installation

Installing the package is quick and easy whether you use a package manager like Wally or work directly in Studio.

Wally (Recommended)

Add the following to your wally.toml and run wally install to download the package.

[dependencies]
ComplexRegions = "vocksel/[email protected]"

Make sure the resulting Packages folder is synced into your experience using a tool like Rojo.

Roblox Studio

  • Download a copy of the rbxm from the releases page under the Assets section.
  • Drag and drop the file into Roblox Studio to add it to your experience.

Documentation

You can find the documentation here.

Contributing

See the contributing guide.

License

MIT License