Skip to content

Define regions in an experience out of BaseParts of any shape or size

License

Notifications You must be signed in to change notification settings

ghostnaps/complex-regions

 
 

Repository files navigation

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/complex-regions@0.1.2"

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

About

Define regions in an experience out of BaseParts of any shape or size

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Lua 100.0%