Pole Dancing
Last updated
Last updated
All In One: This script is Standalone, so it works with ALL frameworks, with a single purchase.
This script will add the ability to pole dance in 3 different styles, at Vanilla Unicorn (or elsewhere) with simple commands. When standing close to a pole, using the commands will make the player grab the pole and begin their dance.
You can customize the commands in the config.lua file. Included are coordinates for the default VU, as well as the commonly used MLO by . You are also able to add more coordinates for poles, so you can enable these fancy animations at poles all around your city!
Purchasing this script will provide access to 2 versions of dam_poledance. Hundreds of copies of version 1 have sold, however I was never happy that it was difficult to add custom poles, as the exact coordinates for poles doesn't align with the animation correctly. So these coordinates needed tweaking to ensure the dancer grabs the pole correctly during the animation. To account for this, among other improvements, version 2 provides an animation offset, which is used when playing the animation. This means you can now set the exact coordinates of a pole, and the animation should line up correctly without needing to offset these coordinates manually in your config.
Additionally, if you wish to trigger these dances externally, you can also use a client event.
Assuming dance is the number 1, 2 or 3;
In a client script:
TriggerEvent("dam_poledance:client:PoleDance", dance)
In a server script:
TriggerClientEvent("dam_poledance:client:PoleDance", source, dance)
Feel free to use version 1 or 2 (both are granted access in your Keymaster upon purchase).
v2.1 UPDATE: Newer emote scripts prevent players from canceling an animation that isn't triggered directly through their script. v2.1 now includes a built-in system allowing players to easily exit the animation when they choose, as well as the ability to run additional code when the dancing starts, such as a hint about how to stop!
Upload the script to your server's "resources" folder (or any [sub_directory])
Configure settings to your needs in config.lua
Ensure the script is starting in your server.cfg
Use any of the 3 commands when close to a configured pole.
By default the commands, which can be changed in config.lua, are;
/pole1
/pole2
/pole3Config = {}
Config.CommandName = "pole" -- The command name to be used, which will be followed by 1, 2 or 3 (eg. /pole1) | Default: "pole"
Config.CommandDescription = "Pole Dance at VU" -- The command description/hint/suggestion to show when typing it in chat | Default: "Pole Dance at VU"
Config.UseGabz = false -- Set true if using Gabz Vanilla Unicorn MLO, false for default GTA V mapping | Default: false
Config.LoopDances = true -- When the animation for a dance finishes, loop to keep dancing | Default: true
Config.QBCoreScriptName = "qb-core" -- The name of the QBCore resource (Don't edit unless you changed the name of qb-core) | Default: "qb-core"
Config.ESXScriptName = "es_extended" -- The name of the ESX resource (Don't edit unless you changed the name of es_extended) | Default: "es_extended"
Config.OldESX = false -- If using the old esx:getSharedObject event, instead of the export function, make this true | Default: false
Config.DefaultPoles = { -- Coordinates of the 3 VU poles that will be used with Config.UseGabz set to false
vector3(104.18, -1293.94, 29.26),
vector3(102.24, -1290.54, 29.26),
vector3(112.60, -1286.76, 28.56)
}
Config.GabzPoles = { -- Coordinates of the 3 VU poles that will be used with Config.UseGabz set to true
vector3(102.23, -1289.85, 29.25),
vector3(104.77, -1294.17, 29.25),
vector3(108.85, -1289.03, 29.25)
}Config = {}
Config.Debug = false -- Enable visible markers to check your pole coordinate configuration | Default: false
Config.CommandName = "pole" -- The command name to be used, which will be followed by 1, 2 or 3 (eg. /pole1) | Default: "pole"
Config.CommandDescription = "Pole Dance" -- The command description/hint/suggestion to show when typing it in chat | Default: "Pole Dance"
Config.LoopDances = true -- When the animation for a dance finishes, loop to keep dancing | Default: true
Config.PlaybackSpeed = 1.3 -- Playback speed for animations, where 1.0 is normal speed (1.3 looks best in my opinion) | Default: 1.3
Config.AnimOffset = vector2(0.055, 0.263) -- Vector2 (X & Y) offset between pole coordinates & animation | Default: vector2(0.055, 0.263)
Config.StopDanceKey = 73 -- Key code for stopping the animation (nil to disable) | Default: 73 (X)
Config.StopDanceHint = function() -- Custom function (client-side) that triggers when you start dancing
-- TriggerEvent("esx:showNotification", "Press X to stop dancing", "info", 5000) -- ESX hint notification
-- TriggerEvent("QBCore:Notify", "Press X to stop dancing", "primary", 5000) -- QBCore hint notification
-- TriggerEvent("ox_lib:notify", { title = "Pole Dancing", description = "Press X to stop", type = "inform" }) -- ox_lib hint notification
return -- No hint notification
end
Config.Poles = {
vector3(104.191, -1294.281, 29.26), -- Vanilla VU
vector3(102.245, -1290.905, 29.26), -- Vanilla VU
vector3(112.609, -1287.025, 28.46), -- Vanilla VU
-- vector3(104.775, -1294.477, 29.25), -- Gabz VU
-- vector3(102.219, -1290.152, 29.25), -- Gabz VU
-- vector3(108.795, -1289.293, 29.25), -- Gabz VU
}
Subscription-based
No
Lines (approximately)
~100
Requirements
None
Support
Yes
