Skip to main content
Image

ToggleConnotations

Helps you toggle connotations on or off. Useful for debugging.
Force
Boolean
If Force is true, it toggles on helpful messages.
CustomModifiers:ToggleConnotations(true)

Connotation

Outputs a connotation message.
Text
String
required
The message to connotate.
CustomModifiers:Connotation("Example Connotation")

Caption

Displays a caption in the DOORS captions.
Text
String
required
The message to display.
CustomModifiers:Caption("Example Caption")

EnableFloor

Enables or disables a floor.
Floor
String
required
The target floor to enable or disable.
Status
Boolean
The state you want to set the floor to.
CustomModifiers:EnableFloor("Mines", true)

UpdateFloorStuff

Updates all modifiers and categories for the current floor.
CustomModifiers:UpdateFloorStuff()

DeleteModifier

Modifier to delete.
Modifier
String
required
Target modifier to delete.
All
Boolean
Delete every single modifier.
CustomModifiers:DeleteModifier("Example", false)

DeleteCategory

Category to delete.
Category
String
required
Target category to delete.
All
Boolean
Delete every single category.
CustomModifiers:DeleteCategory("Example Category", false)

DeleteFloor

Floor to delete.
Floor
String
required
Target floor to delete.
CustomModifiers:DeleteFloor("Example Floor")

RestoreModifier

Deleted modifier to restore.
Modifier
String
required
Target modifier to restore.
All
Boolean
Restore every single deleted modifier.
CustomModifiers:RestoreModifier("Example", false)

RestoreCategory

Deleted category to restore.
Category
String
required
Target category to restore.
All
Boolean
Restore every single deleted category.
CustomModifiers:RestoreCategory("Example Category", false)

RestoreFloor

Deleted floor to restore.
Floor
String
required
Target floor to restore.
All
Boolean
Restore every single deleted floor.
CustomModifiers:RestoreFloor("Example Floor", false)

CreateModifier

Creates a custom modifier with the specified parameters.
params
Table
required
The parameters to create the modifier with.
CustomModifiers:CreateModifier({
	Title = "Example",
	Desc = "This is an example custom modifier!",
	Color = Color3.fromRGB(255, 222, 189),
	Category = "Example Category",
	Sort = -2,
	Merge = nil,
	Bonus = 9999,
	Solo = true,
	Penalties = {
		NoRift = true, 
		NoProgress = true
	},
	Unlock = "Join",
	Activation = [[
		print("Custom Code Logic In Here!")
	]]
})

CreateCategory

Creates a custom category with the specified parameters.
params
Table
required
The parameters to create the category with.
CustomModifiers:CreateCategory({
	Title = "Example Category",
	Sort = -1,
	Floor = "Example Floor",
	Color = Color3.fromRGB(255, 222, 189)
})

CreateFloor

Creates a custom floor with the specified parameters.
params
Table
required
The parameters to create the floor with.
CustomModifiers:CreateFloor({
	Title = "Example Floor",
	Destination = "Hotel",
	Image = "rbxassetid://18992618548",
	Font = Enum.Font.Oswald,
	FontColor = Color3.fromRGB(255, 222, 189),
	Theme = Color3.fromRGB(252, 219, 187),
	Sort = 1,
	Requires = {
		NeedAll = false,
		Achievements = {
			"Join",
			"SpecialQATester"
		}
	},
	Moddable = true
})