World effects

Each marker in game can have its own FX world effects for example such as smoke/any other effect/your custom coded one

You can add another world effect list in directory: xdiskjockey/worldeffects/config/*.lua

Each file in the directory mentioned above represent the DJ mixer and its own custom effects

The basic code to make a new one would look like this:

-- The key must be same like in Config.MixerList otherwise it wont show in mixer
Config.WorldEffects["Galaxy club"] = {
	effects = {
		-- first effect
		{
			-- effect enum name (Will be described below)
			name = Effects.COMET,

			-- What kind of button type it is (Will be described below)
			ButtonType = ButtonType.TOGGLE,

			-- position list where all the effect will happen
			position = {
				-- first position
				{
					-- the mixer position
					mixerPosition = vector3(-1595, -3012, -79),
					particlesPosition = {
						-- pos = position where the effect will happened
						-- rot = rotation of the effect
						-- the last argument for rotation is unusually the scale of the effect.
						{ pos = vector3(-1596.2, -3008.02, -80.8), rot = vector4(-90.0, 0, 0, 1.5) },
						{ pos = vector3(-1598.43, -3015.68, -80.8), rot = vector4(-90.0, 0, 0, 1.5) },
					}
				},
				-- another one
				{
					--......
				},
			},
		},
		-- second effect
		{
			--....  
		},
	},
}

So what is the: Effects?

Effects is enum of existing and ready to use in-game effects, can be used for EVERY mixer in game ( beside player spawned one )

You can find all existing effects in xdiskjockey/const.lua

So what is the: ButtonType?

ButtonType are all kind of buttons type lets see which one are which

  • Button: simple UI button (for one time use)

  • Toggle: it is switch button (this is used for effects you want to turn off in for example 5/10/20 minutes or never thats up to you)

  • list: list of the FX effects that are possible to use

You can find all existing button types in xdiskjockey/const.lua

Let's see some example for some button types

ButtonType.BUTTON example

ButtonType.LIST example

ButtonType.TOGGLE example

PreviousAdd new sound effectNextIntegrations

Last updated

Was this helpful?