Modifed Volume Slider Control Script [English]

VolConMinPos = 1063
VolConMaxPos = 1872
VolConWidth = 18
VolConYPos = {558; 477; 395} --music(0),sfx(1),voice(2) 

VolConTotal works out the actual width of the slider rail. Slider1 is the total divided by 100 to work out percentage [%] value! defaultHoldTime is for the mouse hold button actions play_sound gets the location to an action containing a play sound file action play_speech gets the location to an action containing a background speech file action

VolConTotal = VolConMaxPos - VolConMinPos
Slider1 = VolConTotal / 100
defaultHoldTime = game:getInt(VGameHoldTime)
play_sound = getObject('Scenes[Options_Menu].SceneActions[play_sound]')
play_speech = getObject('Scenes[Options_Menu].SceneActions[play_speech]')

beginVolCon() is the initial loading function for this script & starts the handle animations & calculates the start positions of the handles. i = integer (0,1,2 which defines which volume type we are manipulating - see higher up the post) startAnimation blah blah - we required 2 startAnimations to be able to control an inactive & an active handle. VolVal is the variable we are storing the volume levels in for the current volume type. º the code if else statements are just checking that the volume levels aren't below 0% or over 100% VolConPos is calculating where the handles should be placed. setVolConPos sets the required handles where they need to be based on the calculations done in VolConPos Print adds message to log file declaring the volume script has been initialized!

function beginVolCon()
  for i = 0, 2 do
    startAnimation("Animations[AniVolCon_" .. i .. "]")
    startAnimation("Animations[AniVolCon_" .. i .. "x]")
    local VolVal = getVolume(i)
    if VolVal < 0 then
      setVolume(i, 0)
      VolVal = 0
    elseif VolVal > 100 then
      setVolume(i, 100)
      VolVal = 100
    end
   
    local VolConPos = math.floor((VolVal * Slider1 + VolConMinPos) + 0.5)
 setVolConPos(i, VolConPos)
  end
 print("volume script has been started!")
end

I had to add 2 separate functions for declaring handle positions as it didn't like it when I tried declaring them using an if else statement as it didn't seem to be registering my condition variable for handle_is_active fast enough and thus defaulted to using the else part - so I added an extra function instead with a single animation which is used for the plus minus button part of the script.

-- Set the positions of the slider handles (slider only)
function setVolConPos(typ, xpos)
  local VolAnim = getObject("ActiveAnimations[AniVolCon_" .. typ .. "]")
  local VolAnim2 = getObject("ActiveAnimations[AniVolCon_" .. typ .. "x]")
  VolAnim:setValue(VAnimationCurrentPosition, {x=xpos,y=VolConYPos[typ + 1]})
  VolAnim2:setValue(VAnimationCurrentPosition, {x=xpos,y=VolConYPos[typ + 1]})
end
-- Set the positions of the slider handles (buttons only)
function setVolConPos2(typ, xpos)
  local VolAnim = getObject("ActiveAnimations[AniVolCon_" .. typ .. "]")
  VolAnim:setValue(VAnimationCurrentPosition, {x=xpos,y=VolConYPos[typ + 1]})
end

don't think I need to explain this one!

-- Checks if mouse button is being held down
function mousebtnHold(standard)
  if standard == false then
    game:setValue(VGameHoldTime, 1)
  else
    game:setValue(VGameHoldTime, defaultHoldTime)
  end
end

calculates where the required handle should be while mouse button is held down by using current cursor position. also checks to see if you've reached start or end of the rail to prevent you from dragging any further.

-- The function which allows you to drag the slider handle
function dragVolCon(typ)
  local CursorPos = getCursorPos()
  local VolConPos = math.floor(CursorPos.x - VolConWidth / 2 + 0.5)
  
  if VolConPos < VolConMinPos then
    VolConPos = VolConMinPos
  elseif VolConPos > VolConMaxPos then
    VolConPos = VolConMaxPos
  end
  setVolConPos(typ, VolConPos)
  local VolVal = math.floor(((VolConPos - VolConMinPos) / Slider1) + 0.5)
  setVolume(typ, VolVal)
end

controls what clicking on the plus minus buttons will do. checks if current vol is over/under 100/0 % & if not it will add/subtract 10% each time you click a button the plus minus value is controlled by cond (condition: true|false - true = plus, false = minus) like so: "execute a script" > pluminClick(0, true) - this will increase the volume level for music by 10% if it's under 100% it also checks the typ (int value) to determine if it should play a sound/speech file or do nothing (in case of music) & determine what to print to the log file

-- Plus_Minus Buttons raise or lower vol by 10%
function pluminClick(typ, cond)
  VolVal = getVolume(typ)
  if cond == true then
    VolVal = VolVal + 10
    if VolVal > 100 then VolVal = 100 end
  else
    VolVal = VolVal - 10
    if VolVal < 0 then VolVal = 0 end      
  end
  setVolume(typ, VolVal)
  local VolConPos = math.floor((VolVal * Slider1 + VolConMinPos) + 0.5)
  setVolConPos2(typ, VolConPos)
 if typ == 1 then
  startAction(play_sound)
  print("sound volume is now set at " .. VolVal .. " - button")
 else
 if typ == 2 then
  startAction(play_speech)
  print("speech volume is now set at " .. VolVal .." - button")
 else
  print("music Volume is now set at " .. VolVal .. " - button")
 end
 end
end -- pluminClick()

º 4 or 6 objects for minus/plus buttons (depending on whether you are planning on using audible speech) º 3 or 6 objects for inactive/active slider handles (depends on if you plan on adding active handle image)

& that's it for the objects

quick note: we also have a few actions, conditions & values set on the "Options_Menu" itself which are used to control various things with the volume slider script!

Actions: º At beginning of scene ** "execute a script" > beginVolCon() -- this loads the volume script (on my game menu I have this on the main_menu > options button instead) ** call action > "ani_reset" -- this is a call by other action where I added the menu reset actions - in this case it turns off the active handle animations - I tend to create global call by other action on my main character which I use to reset/control various in game settings & misc things! º "execute a script" > endVolCon() -- this would be used if we were closing the scene with the volume script! º call by other action > "play_sound" -- reflects play_sound found in main script which calls this action to play a sound. º call by other action > "play_speech" -- reflects play_speech found in main script which calls this action to play a speech file.

Conditions: º sfx_is_on -- this determines if current vol type is sound & is used in mouse button release section. º voice_is_on -- this determines if current vol type is speech & is used in mouse button released section.

Values: º which_volcon_is_active -- reflected in mouse button hold section to determine which vol type / slider is currently active

onto what's inside the objects ...

inside the plus/minus objects we only need one action which is: "left click" > "execute a script" > pluminClick(int, true|false)

examples: º pluminClick(0, true) -- adds 10% to current music level if less than 100% º pluminClick(0, false) -- subtracts 10% from current music level if more than 0% º pluminClick(1, true) -- adds 10% to current sound level if less than 100% º pluminClick(1, false) -- subtracts 10% from current sound level if more than 0% º pluminClick(2, true) -- adds 10% to current speech level if less than 100% º pluminClick(2, false) -- subtracts 10% from current speech level if more than 0%

inside the inactive slider object (in our case "Voice|Sfx|Music_Slider (options)" we have 3 actions. "called by other action" > ActVol_(int) -- called via main script º "execute a script" > dragVolCon(int) -- int determines which which handle is being dragged [int = 0,1 or 2] º misc > pause > 50ms -- this creates a slight pause before ... º Jump 2 action part(s) backwards -- this loops back to dragVolCon(int) - which gets current cursor position & amends handle to it!

the active slider objects just contain an animation image which is set as same name as the one in the inactive slider object but with an "x" added to the name which is read inside of the main script file!

quick note: animations need to be set on "infinite" or they will disappear after pause time / loop amount. also it's a good idea to set a high pause time like "20000" so we don't add unnecessary cpu usage by having it looping rapidly for no reason.

the animation & called by other action names inside the objects have to reflect the names in the main script & vice versa!

"Cursor enters object area" º set value > "which_volcon_is_active" = (int) -- determines which slider is currently active º "execute a script" > mousebtnHold > false -- not entirely sure (think it determines if button hold is allowed)

"Cursor leaves object area" º set value > "which_volcon_is_active" = -1 -- resets to init value of which slider is active (none) º "execute a script" > mousebtnHold > true -- not entirely sure (still (think it determines if mouse button hold is allowed )) º call other action > "ani_reset" -- global action I created to reset menu items (in this case; hide active handles) º quit action > "ActVol_(int)" -- stops the current action from looping!

-*-

ok onto the final part; setting up the mouse button hold & release actions ...

1. this section defines what happens on mouse button release (even though it's not that clear?) 2. this section defines what happens during mouse button hold

just look at images for info!

-* one *- (button released)

-* two *- (button hold)

quick note: I tend to add my global reset & control actions to my main character like so:

in this case we are hiding the active slider handles!

the only spoken part of the track is taken from "Hard Candy" which is a movie I sampled from many times for a few of the tracks I made!