Difference between revisions of "MQ2Twist" - MMOBugs Wiki

(New page: {{plugin}} {{Pluginbox | name = MQ2Twist | author =Cr4zyb4rd | link = [http://www.mmobugs.com/wiki/index.php/MQ2Twist Wiki Link] | commands=/twist | source = Yes | uses...)
 
 
(6 intermediate revisions by 3 users not shown)
Line 6: Line 6:
 
| commands=/twist
 
| commands=/twist
 
| source = Yes
 
| source = Yes
| usesini = No
+
| usesini = Yes
 
}}
 
}}
 
==Description==
 
==Description==
Line 14: Line 14:
 
==Commands==
 
==Commands==
  
* <span class="highlight2">/twist # # # # # - Twists in the order given.  
+
* <span class="highlight2">/twist # [#] [#] [#] [#] [...]/span> : Twists in the order given.  
             Valid options are 1 thru 8 for song gems, and 10 thru 19 for item clicks.  
+
             Valid options are 1 thru 12 for song gems, and 21 thru 40 for item clicks.  
             These may be mixed in any order, and repeats are allowable. Up to 10 may be  
+
             These may be mixed in any order, and repeats are allowable. Up to 32 may be  
 
             specified.  
 
             specified.  
 
             If a song is specified with a duration longer than standard (ie, selos)  
 
             If a song is specified with a duration longer than standard (ie, selos)  
Line 22: Line 22:
 
             would be a 2 song twist with selos pulsed every 2.5 min.  
 
             would be a 2 song twist with selos pulsed every 2.5 min.  
 
   
 
   
* <span class="highlight2">/twist hold <GEM #></span> : Pause twisting and sing only the specified song  
+
* <span class="highlight2">/twist hold <GEM #> : Pause twisting and sing only the specified song  
 
* <span class="highlight2">/sing <GEM#></span> : alias for /twist hold  
 
* <span class="highlight2">/sing <GEM#></span> : alias for /twist hold  
* <span class="highlight2">/twist [stop|end|off]</span> : stop twisting, does not clear the twist queue  
+
* <span class="highlight2">/twist once # [#] [...]</span> : Twists once in the order given, then reverts to original twist.
 +
* <span class="highlight2">/twist [stop|end|off]</span> : Stop twisting, does not clear the twist queue  
 
* <span class="highlight2">/stoptwist</span> : alias for /twist stop  
 
* <span class="highlight2">/stoptwist</span> : alias for /twist stop  
 
* <span class="highlight2">/twist</span> or <span class="highlight2">/twist [start|on]</span> - Resume the twist after using /twist hold or /twist stop  
 
* <span class="highlight2">/twist</span> or <span class="highlight2">/twist [start|on]</span> - Resume the twist after using /twist hold or /twist stop  
 +
* <span class="highlight2">/twist reset</span> : Reset timers for item clicks and long duration songs
 +
*<span class="highlight2">/twist clear</span> : Stops twisting and clears the twist queue.
 +
* <span class="highlight2">/twist adjust</span> : In ticks, how early to recast long duration songs
 
* <span class="highlight2">/twist delay #</span> : (10ths of a second, minimum of 30, default 33  
 
* <span class="highlight2">/twist delay #</span> : (10ths of a second, minimum of 30, default 33  
* <span class="highlight2">/twist reload</span> : reload the INI file to update item clicks  
+
* <span class="highlight2">/twist reload</span> : Reload the INI file to update item clicks and AAs
 +
* <span class="highlight2">/twist load</span> : Same as /twist reload
 
* <span class="highlight2">/twist slots</span> : List the slots defined in the INI and their #'s
 
* <span class="highlight2">/twist slots</span> : List the slots defined in the INI and their #'s
 +
* <span class="highlight2">/twist set [click#] [Cast] [Recast] [Name] [Slot]</span> : Sets a slot to be defined in the INI
 
* <span class="highlight2">/twist quiet</span> : Toggles songs listing and start/stop messages for one-shot twists
 
* <span class="highlight2">/twist quiet</span> : Toggles songs listing and start/stop messages for one-shot twists
  
Line 41: Line 47:
  
 
==INI File==
 
==INI File==
 +
 +
Located in server_char.ini:
  
 
     [MQ2Twist]  
 
     [MQ2Twist]  
     Delay=32                Delay between twists (in 10ths of a second). Lag & System dependant.  
+
     ;Delay between twists (in 10ths of a second). Lag & System dependant.  
     Adjust=1                 This defines  how many ticks before the 'normal'  
+
     Delay=32                  
                        recast time to cast a long song.  
+
    ;This defines  how many ticks before the 'normal' recast time to cast a long song.
 +
    Adjust=1               
 +
    ;Shadowsong cloak
 +
    21_CastTime=30
 +
    21_ReCastTime=350
 +
    21_Name=Shadowsong Cloak
 +
    21_Slot=DISABLED
 +
    ;girdle of living thorns (current belt will be swapped out)
 +
    22_CastTime=0
 +
    22_ReCastTime=11600
 +
    22_Name=Girdle of Living Thorns
 +
    22_Slot=waist
 +
    ;nature's melody
 +
    23_CastTime=-1
 +
    23_ReCastTime=135
 +
    23_Name=DISABLED
 +
    23_Slot=mainhand
 +
    ;lute of the flowing waters
 +
    24_CastTime=0
 +
    24_ReCastTime=0
 +
    24_Name=Lute of the Flowing Waters
 +
    24_Slot=DISABLED
 +
    ;lute of the flowing waters
 +
    25_CastTime=32
 +
    25_ReCastTime=120
 +
    25_Name=Cassindra's Chorus of Clarity
 +
    25_Slot=AA
 +
 
 +
==Macro Data==
 +
 
 +
This plugin adds a new TLO called Twist.
  
 +
===ExampleType===
 +
* <span class="highlight2">${Twist.Twisting} : bool</span> - Return TRUE if twisting.
 +
* <span class="highlight2">${Twist.Next} : int</span> - Return next song: 0 if not twisting, -1 if casting item, or gem # of current twisted song.
 +
* <span class="highlight2">${Twist.Current} : int</span> - Return current song: 0 if not twisting, -1 if casting item, or gem # of current twisted song.
 +
* <span class="highlight2">${Twist.List} : string</span> - Return space separated list of gem and item #'s being twisted, in order.
  
 
==Availability==
 
==Availability==

Latest revision as of 13:31, 14 December 2010

Plugin Info
Name MQ2Twist
Author Cr4zyb4rd
Link Wiki Link
Commands /twist
Source Available Yes
Uses INI File Yes

Description

Bard song twisting. Like melody on steroids.

Commands

  • /twist # [#] [#] [#] [#] [...]/span> : Twists in the order given.
           Valid options are 1 thru 12 for song gems, and 21 thru 40 for item clicks. 
           These may be mixed in any order, and repeats are allowable. Up to 32 may be 
           specified. 
           If a song is specified with a duration longer than standard (ie, selos) 
           that song will be twisted based on it's duration.  For example, riz+mana+selos 
           would be a 2 song twist with selos pulsed every 2.5 min. 

  • /twist hold <GEM #> : Pause twisting and sing only the specified song
  • /sing <GEM#> : alias for /twist hold
  • /twist once # [#] [...] : Twists once in the order given, then reverts to original twist.
  • /twist [stop|end|off] : Stop twisting, does not clear the twist queue
  • /stoptwist : alias for /twist stop
  • /twist or /twist [start|on] - Resume the twist after using /twist hold or /twist stop
  • /twist reset : Reset timers for item clicks and long duration songs
  • /twist clear : Stops twisting and clears the twist queue.
  • /twist adjust : In ticks, how early to recast long duration songs
  • /twist delay # : (10ths of a second, minimum of 30, default 33
  • /twist reload : Reload the INI file to update item clicks and AAs
  • /twist load : Same as /twist reload
  • /twist slots : List the slots defined in the INI and their #'s
  • /twist set [click#] [Cast] [Recast] [Name] [Slot] : Sets a slot to be defined in the INI
  • /twist quiet : Toggles songs listing and start/stop messages for one-shot twists

Examples

     /twist 1           Sing gem 1 forever 
     /twist 1 2 3       Twist gems 1,2, and 3 forever 
     /twist 1 2 3 10    Twist gems 1,2,3, and clicky 10, forever 
     /twist hold 4      Sing gem 4 forever, until another singing-related /twist command is given
     /sing 4            Same as above

INI File

Located in server_char.ini:

    [MQ2Twist] 
    ;Delay between twists (in 10ths of a second). Lag & System dependant. 
    Delay=32                 
    ;This defines  how many ticks before the 'normal' recast time to cast a long song.
    Adjust=1                 
    ;Shadowsong cloak 
    21_CastTime=30 
    21_ReCastTime=350 
    21_Name=Shadowsong Cloak 
    21_Slot=DISABLED 
    ;girdle of living thorns (current belt will be swapped out) 
    22_CastTime=0 
    22_ReCastTime=11600 
    22_Name=Girdle of Living Thorns 
    22_Slot=waist 
    ;nature's melody 
    23_CastTime=-1 
    23_ReCastTime=135 
    23_Name=DISABLED 
    23_Slot=mainhand 
    ;lute of the flowing waters 
    24_CastTime=0 
    24_ReCastTime=0 
    24_Name=Lute of the Flowing Waters 
    24_Slot=DISABLED 
    ;lute of the flowing waters 
    25_CastTime=32
    25_ReCastTime=120
    25_Name=Cassindra's Chorus of Clarity 
    25_Slot=AA

Macro Data

This plugin adds a new TLO called Twist.

ExampleType

  • ${Twist.Twisting} : bool - Return TRUE if twisting.
  • ${Twist.Next} : int - Return next song: 0 if not twisting, -1 if casting item, or gem # of current twisted song.
  • ${Twist.Current} : int - Return current song: 0 if not twisting, -1 if casting item, or gem # of current twisted song.
  • ${Twist.List} : string - Return space separated list of gem and item #'s being twisted, in order.

Availability

This plugin is included with the MMOBugs Compile.