Party Invite Alarm Script

[tyreafus]

I'm working on a script to make an alarm go off when you get a party invite, allowing you to do something besides sit at the keyboard while you wait for a party. I haven't programmed anything since high school, so I'm definitely a little rusty. Also I have absolutely no experience with Lua, but I think I'm starting to get a hold on it. I decided to use the ingame /p <call1> for the alarm because I'm not sure how to use external sound files in Lua. Since you're not in a party when you get an invite, it'll only show up on your computer anyway^^.

I think I've worked out most of the kinks , but I still can't get the thing to work. I think the chat commands for Lunar are still buggy(as the docs said). Also I seem to have problems if I run a script more than once in a session, even if the script has ended or I've unloaded it via the console.

Anyway, I figured I'd post what I have so far, maybe some of you will see something I'm missing. I'm not sure how you all make those code boxes so I'm just gonna have to post it as regular text:


a=true
Control.control_BindKey("RBRACKET",true,false,true,"keyboard_sendstring /echo stop")
Control.control_SendString("/echo Start")
while a==true do
  Wi[sup][/sup]ndower.script_sleep(50)
  newlinenum=FFXI.chat_GetNewestLineNumber()
  newline=FFXI.chat_GetLine(newlinenum)
  newline = newline .. " "
  linetype=FFXI.chat_GetLineType(newlinenum)
  if newline=="stop " then
     a=false
  end
  if linetype=="87" then
     local firstspc = string.find(newline, (" "))
     firstspc=firstspc+1
     local endinv=sfirstspc+27
     local testline=string.sub(newline,spaces,endinv)
     if testline=="invites you to join a party." then
        Windower.script_Sleep(1000)
        Control.control_SendString("/p <call1>")
     end
  end
end
Windower.script_Sleep(1000)
Control.control_SendString("/echo End.")



I got the 87 using another script i made to test the colors and types of chatlog text. So TinyTerror if you read this you can put 87 on the documentation for FFXI.chat_GetLineType for Party Invites. I did have trouble with the script I made to test it though. Even after the script had ended the debug window was showing constant looped activity, pulling information from the chat log. I'm not sure why that is. Here is my code for that in case anyone needs to test a chat-text type not already listed in the docs, or for debugging purposes:


function DispLine(LnTxt, LnTyp, LnClr)
  DispTxt = Graphics.text_CreateObject()
  DispType = Graphics.text_CreateObject()
  DispColor = Graphics.text_CreateObject()
  --
  Graphics.text_SetBold(true,DispTxt)
  Graphics.text_SetColor(255,255,255,255,DispTxt)
  Graphics.text_SetPosition(50,50,DispTxt)
  Graphics.text_SetText(LnTxt,DispTxt)
  --
  Graphics.text_SetBold(true,DispType)
  Graphics.text_SetColor(255,255,255,255,DispType)
  Graphics.text_SetPosition(50,75,DispType)
  Graphics.text_SetText(LnTyp,DispType)
  --
  Graphics.text_SetBold(true,DispColor)
  Graphics.text_SetColor(255,255,255,255,DispColor)
  Graphics.text_SetPosition(80,75,DispColor)
  Graphics.text_SetText(LnClr,DispColor)
  return 0
end
--
Control.control_BindKey("LBRACKET",true,false,true,"keyboard_sendstring /echo stop")
Windower.script_Sleep(1000)
Control.control_SendString("/echo Start")
a=true
--
while a==true do
  newnum=FFXI.chat_GetNewestLineNumber()
  newline=FFXI.chat_GetLine(newnum)
  if newline == "stop" then
     a=false
  end
  newtype=FFXI.chat_GetLineType(newnum)
  newcolor=FFXI.chat_GetLineColor(newnum)
  Graphics.text_DeleteAll()
  b=DispLine(newline, newtype, newcolor)
  Windower.script_Sleep(50)
end



Suggestions are welcome.

[tyreafus]

Hehe so yeah uh... looking over the other scripts on this board I realized that I probably should have come up with something more useful/more complex before I posted on here. Meh...

P.S. I apologize for the lack of indents. They were there when I made the post... Guess that's why everyone uses those log box things.

[TinyTerror]

Looks good to me

The debug window will always be getting output, even if no scripts are running. There are parts of lunar that are doing things even when there are no scripts loaded, and thats what you are seeing. I think I will remove the debug window for the next version. People seem to be confused by it. I can't really blame them. If I was a normal user who doesn't really do any programming, having a window pop up with a bunch of nasty debug crap in it would confuse me too.

I went ahead and added the code box for you also.

[StarHawk]

just a suggestion Tiny: Make a lua command to open the debug box, and have it auto-close when the script starts. This would allow lua programmers to still have the debugging ability while writing a script.

[tyreafus]

admin said:

Looks good to me

The debug window will always be getting output, even if no scripts are running. There are parts of lunar that are doing things even when there are no scripts loaded, and thats what you are seeing. I think I will remove the debug window for the next version. People seem to be confused by it. I can't really blame them. If I was a normal user who doesn't really do any programming, having a window pop up with a bunch of nasty debug crap in it would confuse me too.

I went ahead and added the code box for you also.

Just wanna clarify: I know that the debug will always be running operations even while no script is loaded. It should not, however, be spamming up to 500 chatline pulls and beyond when i shut down the script at around 130. I think this has a lot to do with the problems people are having with the game crashing when they try to logout or unload Lunar.

P.S. Thank you for fixing my script posts. Can you tell me how to do that in case I post anything else?

[TinyTerror]

The debug window has nothing to do with the instability in unloading lunar. As for the code box, its the little # box along the top of the text box when you click reply.

[tyreafus]

I didn't say that the debug window itself was what causes the problem, but what was being shown in the debug window:



Clk:504640 Tid:2452 FFXIReader.ProcessLine: Pushing line 989 ChatQueue size 201

Clk:504640 Tid:1524 Auto-unloading script party2.lua

Clk:504640 Tid:1524 LunarPlugin.UnloadScript: Started.

Clk:504640 Tid:1524 LunarPlugin.UnloadScript: Target script address: 99C57F0

Clk:504640 Tid:1524 Scriptrunner.StopScript: Started.

Clk:504640 Tid:1524 Scriptrunner.StopScript: Clearing primitives.

Clk:504640 Tid:1524 Scriptrunner.StopScript: Clearing text.

Clk:504640 Tid:1524 Scriptrunner.StopScript: Pimitives and text deleted.

Clk:504640 Tid:1524 Scriptrunner.StopScript: Signaling stop on thread 9DA670.

Clk:504656 Tid:1524 Scriptrunner.StopScript: Waiting for thread 9DA670 to terminate.

Clk:504656 Tid:1524 Scriptrunner.StopScript: Thread 9DA670 terminated.

Clk:504656 Tid:1524 Scriptrunner.StopScript: Lua state 99C5920 closed.

Clk:504656 Tid:1524 Scriptrunner.StopScript: Stopped.

Clk:504656 Tid:1524 LunarPlugin.UnloadScript: Script stopped.

Clk:504656 Tid:1524 Scriptrunner.~Scriptrunner: Started.

Clk:504656 Tid:1524 Scriptrunner.StopScript: Started.

Clk:504671 Tid:1524 Scriptrunner.StopScript: Script already stopped.

Clk:504671 Tid:1524 Scriptrunner.StopScript: Stopped.

Clk:504671 Tid:1524 Scriptrunner.~Scriptrunner: Script thread stopped.

Clk:504671 Tid:1524 Scriptrunner.~Scriptrunner: Stopped.

Clk:504671 Tid:1524 LunarPlugin.UnloadScript: Target deleted.

Clk:504671 Tid:1524 LunarPlugin.UnloadScript: Unload complete.

Clk:504671 Tid:1524 LunarPlugin.UnloadScript: Stopped. (Script found)

Clk:504671 Tid:1524 Auto-unload complete.

Clk:505015 Tid:2452 FFXIReader.ProcessLine: Pushing line 990 ChatQueue size 201

Clk:505359 Tid:2452 FFXIReader.ProcessLine: Pushing line 991 ChatQueue size 201

Clk:505703 Tid:2452 FFXIReader.ProcessLine: Pushing line 992 ChatQueue size 201

Clk:506078 Tid:2452 FFXIReader.ProcessLine: Pushing line 993 ChatQueue size 201

Clk:506437 Tid:2452 FFXIReader.ProcessLine: Pushing line 994 ChatQueue size 201

Clk:506796 Tid:2452 FFXIReader.ProcessLine: Pushing line 995 ChatQueue size 201

Clk:507187 Tid:2452 FFXIReader.ProcessLine: Pushing line 996 ChatQueue size 201

Clk:507531 Tid:2452 FFXIReader.ProcessLine: Pushing line 997 ChatQueue size 201

Clk:507703 Tid:2452 FFXIReader.ProcessLine: Pushing line 998 ChatQueue size 201

Clk:507875 Tid:2452 FFXIReader.ProcessLine: Pushing line 999 ChatQueue size 201

Clk:508218 Tid:2452 FFXIReader.ProcessLine: Pushing line 1000 ChatQueue size 201

Clk:508578 Tid:2452 FFXIReader.ProcessLine: Pushing line 1001 ChatQueue size 201

Clk:508937 Tid:2452 FFXIReader.ProcessLine: Pushing line 1002 ChatQueue size 201

......more.....

Clk:546078 Tid:2452 FFXIReader.ProcessLine: Pushing line 1121 ChatQueue size 201

Clk:546328 Tid:2452 FFXIReader.ProcessLine: Pushing line 1122 ChatQueue size 201

Clk:546718 Tid:2452 FFXIReader.ThreadFunc: 100 cycles took 15203ms

Clk:546765 Tid:2452 FFXIReader.ProcessLine: Pushing line 1123 ChatQueue size 201

Clk:547031 Tid:2452 FFXIReader.ProcessLine: Pushing line 1124 ChatQueue size 201

Clk:547281 Tid:2452 FFXIReader.ProcessLine: Pushing line 1125 ChatQueue size 201

Clk:547562 Tid:2452 FFXIReader.ProcessLine: Pushing line 1126 ChatQueue size 201

Clk:547812 Tid:2452 FFXIReader.ProcessLine: Pushing line 1127 ChatQueue size 201

Clk:547937 Tid:2452 FFXIReader.ProcessLine: Pushing line 1128 ChatQueue size 201

Clk:548062 Tid:2452 FFXIReader.ProcessLine: Pushing line 1129 ChatQueue size 201

Clk:548375 Tid:2452 FFXIReader.ProcessLine: Pushing line 1130 ChatQueue size 201

Clk:548703 Tid:2452 FFXIReader.ProcessLine: Pushing line 1131 ChatQueue size 201

Clk:548953 Tid:2452 FFXIReader.ProcessLine: Pushing line 1132 ChatQueue size 201

Clk:549484 Tid:2452 FFXIReader.ProcessLine: Pushing l



So even after the script was unloaded, Lunar was still processing elements of the script(This was the only script I loaded this session). Now, I would assume Lunar unloads each script before allowing itself to be unloaded. If Lunar isn't fully unloading the scripts, i.e., Lunar is still processing elements of "closed" scripts when it tries to unload, this may be part of what causes the crash upon .Lunar unload.

[sdphantom]

tyreafus said:

I didn't say that the debug window itself was what causes the problem, but what was being shown in the debug window:


Clk:546078 Tid:2452 FFXIReader.ProcessLine: Pushing line 1121 ChatQueue size 201

Clk:546328 Tid:2452 FFXIReader.ProcessLine: Pushing line 1122 ChatQueue size 201

Clk:546718 Tid:2452 FFXIReader.ThreadFunc: 100 cycles took 15203ms

Clk:546765 Tid:2452 FFXIReader.ProcessLine: Pushing line 1123 ChatQueue size 201

Clk:547031 Tid:2452 FFXIReader.ProcessLine: Pushing line 1124 ChatQueue size 201

Clk:547281 Tid:2452 FFXIReader.ProcessLine: Pushing line 1125 ChatQueue size 201

Clk:547562 Tid:2452 FFXIReader.ProcessLine: Pushing line 1126 ChatQueue size 201

Clk:547812 Tid:2452 FFXIReader.ProcessLine: Pushing line 1127 ChatQueue size 201

Clk:547937 Tid:2452 FFXIReader.ProcessLine: Pushing line 1128 ChatQueue size 201

Clk:548062 Tid:2452 FFXIReader.ProcessLine: Pushing line 1129 ChatQueue size 201

Clk:548375 Tid:2452 FFXIReader.ProcessLine: Pushing line 1130 ChatQueue size 201

Clk:548703 Tid:2452 FFXIReader.ProcessLine: Pushing line 1131 ChatQueue size 201

Clk:548953 Tid:2452 FFXIReader.ProcessLine: Pushing line 1132 ChatQueue size 201



Lunar always pops this info up whether or not your script is running. From what I see and read from other topics here, Lunar caches all chat activity for ALL scripts to access. These reports are of the cache, not the script that is pulling from it.

[TinyTerror]

With all due respect, you have no idea how lunar functions internaly. Please don't try to suggest that something is going wrong based on what you see in the debug window. The pushing chat lines are completely independent of scripts, and run even when no scripts have been loaded. The instability is caused by some issues with the lunar libs freeing memory incorrectly. I am working on a fix.

[tyreafus]

OK I guess I misunderstood what the ChatQueue lines were doing. I apologize, I was only trying to help.

Anyway, I finished the script. I found out that there are multiple invite messages:

**** invites you to his party. <--.
**** invites you to her party. <---=both for new parties
**** invites you to join a party. <--for existing parties.

So I brought the line test to just "invites you to".

I also got rid of the type if statement, as it's not really necessary, and I was having trouble getting it to work.
Here's the finished script:

a=true
Control.control_BindKey("RBRACKET",true,false,true,"keyboard_sendstring /echo stop")
Control.control_SendString("/echo Start")
while a==true do
  Windower.script_Sleep(200)
  newlinenum=FFXI.chat_GetNewestLineNumber()
  newline=FFXI.chat_GetLine(newlinenum)
  newline = newline .. " "
  linetype=FFXI.chat_GetLineType(newlinenum)
  if newline=="stop " then
     a=false
  end
  local firstspc = string.find(newline, (" "))
  firstspc=firstspc+1
  local endinv=firstspc+13
  local testline=string.sub(newline,firstspc,endinv)
  if testline=="invites you to" then
     Windower.script_Sleep(1000)
     Control.control_SendString("/p <call1>  " .. linetype)
  end
end
Windower.script_Sleep(1000)
Control.control_SendString("/echo End.")

Hope this helps someone, I know I'll be using it.
Another option for the alarm sound would be to do something using WinampPlugin for Windower.