FXStop - Addon to prevent certain FX

Discussion in 'Player Created Lua Script Repository' started by Tirrag, Nov 5, 2022.

  1. Tirrag

    Tirrag Avatar

    Messages:
    857
    Likes Received:
    1,826
    Trophy Points:
    93
    Location:
    Iowa, USA
    Ring of Fire... Lightning Storm... Unicorns...

    The mere mention of these can cause players to curl up in a ball and scream. If you are one of those players whose PC performance suffers or are deeply affected mentally by the FX from these then this addon is for you :)

    NOTE: This addon blocks both your FX and the FX generated by other players. The block is only from your perspective and other players will see their own FX as well as your FX.

    Utilizing this addon you can stop the FX from occurring for the following:
    • Ring of Fire
    • Fireball
    • Lightning Storm
    • Ice Field
    • Meteor Storm
    • Cone of Cold
    • Solar Flare
    • Earthquake
    • Unicorn Rainbow (also stops the sound)
    • Nightmare Flame
    • Soothing Rain
    This addon is fully functional and is command-line only. Stop/Allow of individual FX is controlled via a simple command syntax entered in the local chat dialog. The command syntax is as follows:

    !fxstop <command> <parameter>

    Core Command List

    help - shows the list of available commands

    ex. !fxstop help

    list - this command lists the available FX to stop and their current block status

    ex. !fxstop list

    stop <fx-key> - this command stops the FX with the passed key from being created by the game. you can get the fx-key from the list command.

    ex. !fxstop stop ringOfFire

    allow <fx-key> - this command allows the FX with the passed key to be created by the game. you can get the fx-key from the list command.

    ex. !fxstop allow ringOfFire

    Getting Started

    To get started you will need to download the FXStop addon at:

    https://shroudoftheavatar.tools/lua/fxstop_v0_03.zip

    Please extract the file from the zip download into your Lua SotA folder. If prompted to overwrite say Yes as all updates to this addon will be backwards compatible. When installed properly you should see a file called:

    sota_point_of_interest_system.lua

    in your root Lua folder. If you cannot find your lua folder, while in-game in the local chat type:

    /datafolder

    This will open up a dialog showing your SotA data folder of which one subdirectory will be the Lua folder.

    If you extracted the files into your Lua folder while in-game they will not be active yet until you either restart the game or in the local chat type:

    /lua reload

    Upon reload, you should see messages in the lua chatbox (be sure lua is checked for that tab) indicating that the addon file has been loaded.

    If you did not see those messages, then you will need to enable it through the new lua addon menu option within SotA. In the upper-right of the SotA interface click the Window selector icon and select the LUA Add-On(s) Manager option.

    [​IMG]

    In the Lua Add-Ons Manager dialog, find SotA Event System (SES) and ensure it is "On". If it is "Off" then click the "Off" button. If it is already "On", turn if off and then on again as it has been updated already to the latest version.

    [​IMG]

    In the Lua Add-Ons Manager dialog, find FXStop and click the "Off" button if it is showing.

    [​IMG]

    The button should change to a green "On" and you should see Lua messages indicating the addon file has been loaded.

    Usage

    All commands should be entered in the local chat. To do so use /l in the chat to enter local chat channel.

    You can try out your first command with:

    !fxstop list

    By default all FX are allowed. To stop Lightning Storm from being played use the command:

    !fxstop stop lightningStorm

    You should see a message in the chat log that the block has been enabled.
     
    Last edited: Nov 20, 2022
    Rhodrisan, Anpu and that_shawn_guy like this.
  2. Tirrag

    Tirrag Avatar

    Messages:
    857
    Likes Received:
    1,826
    Trophy Points:
    93
    Location:
    Iowa, USA
    Update List

    2022-11-05 v0.03 - Converted use of true/false in the ini file to use 0/1. Added debug level command to show debug output.

    2022-11-05 v0.02 - Initial Release.
     
    Last edited: Nov 7, 2022
  3. Tirrag

    Tirrag Avatar

    Messages:
    857
    Likes Received:
    1,826
    Trophy Points:
    93
    Location:
    Iowa, USA
    More info has been added including download link. If you have any questions/comments/feedback please don't hesitate :)
     
    Anpu likes this.
  4. ConjurerDragon

    ConjurerDragon Avatar

    Messages:
    1,724
    Likes Received:
    1,028
    Trophy Points:
    125
    Gender:
    Male
    Location:
    Rhineland-Palatinate
    And I hoped you meant the sounds like the gargling noise when skinning an animal (my character is a woodsman. A ranger. A hunter. It´s his daily job and nothing that makes him throw up. If that is a thing why is not the stench of tannistry or colouring textiles simulated that drove those crafts to be in their own streets usually distant from the nobler parts of cities...).

    Or the sound some guards make when they sneak up on you from behind, salute and seem to clear their throat repeatedly so that it appears as if a monster had stalked you from behind for a moment...
     
  5. Tirrag

    Tirrag Avatar

    Messages:
    857
    Likes Received:
    1,826
    Trophy Points:
    93
    Location:
    Iowa, USA
    greetings and thank you for the feedback :) it most certainly could! i just need to see if those are able to be stopped and add them in :) let me test it out and see.
     
  6. Tirrag

    Tirrag Avatar

    Messages:
    857
    Likes Received:
    1,826
    Trophy Points:
    93
    Location:
    Iowa, USA
    and unfortunately no :( i will suggest it and see if we can get any exposure to it.
     
  7. FrostII

    FrostII Bug Hunter

    Messages:
    5,891
    Likes Received:
    11,040
    Trophy Points:
    153
    Gender:
    Male
    Location:
    Pacific Northwest
    @Tirrag
    Is this add-on currently functioning properly ?
    If so, you might consider removing from the OP :
     
    Anpu likes this.
  8. Tirrag

    Tirrag Avatar

    Messages:
    857
    Likes Received:
    1,826
    Trophy Points:
    93
    Location:
    Iowa, USA
    greetings! it is not yet :( DevilCult did get it fixed and i tested it in Q/A. just waiting on it to make it to production build.
     
    Anpu likes this.
  9. Gia2

    Gia2 Avatar

    Messages:
    358
    Likes Received:
    638
    Trophy Points:
    55
    Gender:
    Male
    Thank you forthe mod! I would love to stop Floating DMG or toggle them personal / party / enemy / NPC
    is that possible?