Update to Airship Schedule

[Jimmytime]

Hello all. First post, but I've been lurking here for a while. Feedback and critiques encouraged ^^

Aim:

Get my feet wet for lua scripting by manupulating a pre-existing script. Even if I don't do anything inovative code-wise I'll be learning the ropes without starting from absolutely nothing.

Goals:

1.) Change Nebula's airship schedule script into something with more graphics/formatting.
2.) First format it to look good on my computer's settings, then code more flexibility in.
3.) Post progress on this forum for feedback/critique.

Current Questions:

1.) Object Layer Order: I want to eventually mimic an in-game window for the background. From what I can tell from other posts, the layering of text over background images is not possible yet due to how Lunar interfaces with FFXI, but it is being worked on for future release, and seems do-able. Is that correct? If so I can at least get the background image creation started, in hopes of eventually ditching the transparent window background.

2.) # of text/image objects: A new object variable has to be created for each image/text box, correct? Meaning, I can't set up a text object with a certain font and size, print it, then re-use the object to print elsewhere on the screen. My original text would vanish. A way to eliminate redundant or repetetive code would be some sort of type definition that could be used multiple times, or a function that sets up a passed object, yes? In particular I would want this for my creation of the objects for the city, arrow, and airship icons, not to mention the two text boxes. I already intend to make a loop for the creation of the row across of icons, and one for the column down.

3.) Speed/Variable Issues: In an effort to make the code more efficient, what is the best way to treat the variables as far as local/global go, keeping in mind that the scope of this script? It seems like every time GetSchedule is run, the offsets are re-created, then destroyed at the end of the function. Is more memory/time used up if they are globals?

4.) Image Problems: During testing I start the script, check for my changes, almost immediately unload the script, and continue writing, repeating this an ungodly number of times throughout the night. I've noticed during some loads, some of the icons are loaded at full size instead of their reduced size. Are images not intended to be scaled yet, given the current capabilities of the interface? Or am I missing something in my object setup? Related question: The last row and column of pixels gets cut off on the images I'm displaying. Is this related to the above questions?

5.) If/Then Question: Since this is an adaptation of Neb's code, I kept his schedule function almost the same but call it twice since I need 2 columns instead of one. I added an If/Then and passed a variable to control it, but the lists that get output are reversed in order. I'm missing something obvious.

6.) Advanced Key Binding: I’m pretty familiar with the way Windower handles keybinds, but not Lunar. I can see how to bind/unbind and use keyboard input mostly from X-Drop’s programs, but I’m wondering if more advanced binding is possible yet, such as binding a command to key combos like alt+1, ctrl+e, leftwindows+F2, etc. Also, perhaps someone could clarify the order in which keyboard input it routed to Lunar, Windower, and FFXI. I’m interested in stopping certain key combinations from getting to FFXI so I can use them either in a lunar script or windower macro, but I have a feeling I’ll have to see the folks over at Azaril’s forum for something like that, right? I’m also interested in using the windows key like alt or ctrl is used in Windower/FFXI for macros.

Just a quick note: I’m trying to search for my own answers the best I can on this forum and on the web (when my question applies to lua scripting in general), so if there are answers to these questions on this forum that are highly visible, sorry that I have missed them :^)

Code:


-- Airship.lua
-- Version: 0.5
-- 01/16/05
-- By: JimmyTime
-- Purpose: Displays the departure schedule for airships
-- Notes:
--      - Based off of Nebula's Airship.lua
--      - Borrowed heavily from X-Drop's design of AggroCheck.lua

function Initialize()
 -- Initialize Variables
 GMTOffset = -5
 FixTime = 15*60

 xOffset = 2   -- x offset from the left
 yOffset = 300 -- y offset from the top

 closeHotKey = "F1" -- hot key for exiting the script

 BasisDate = os.time{year=2002, month=6, day=23, hour=16+GMTOffset, min=0, sec=0}
 MoonDate = os.time{year=2004, month=1, day=25, hour=2+GMTOffset, min=31, sec=12}

 VanaDayList = {"Earthsday", "Watersday", "Windsday", "Iceday", "Lightningday", "Lightsday", "Darksday","Firesday"}

 msGameDay = (24 * 60 * 60 * 1000 / 25) -- milliseconds in a game day
 msRealDay = (24 * 60 * 60 * 1000) -- milliseconds in a real day

 Control.control_BindKey(CloseHotKey,true,false,false,".Lunar command Airship.lua Unload")

 Text1 = Graphics.text_CreateObject()
 Graphics.text_SetPosition(xOffset+11,yOffset+14,Text1)
 Graphics.text_SetColor(255,255,255,255,Text1)
 Graphics.text_SetFont("Courier New",9,Text1)
 Graphics.text_SetBold(true,Text1)

 Text2 = Graphics.text_CreateObject()
 Graphics.text_SetPosition(xOffset+90,yOffset+14,Text2)
 Graphics.text_SetColor(255,255,255,255,Text2)
 Graphics.text_SetFont("Courier New",9,Text2)
 Graphics.text_SetBold(true,Text2)

 BackGround=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset,yOffset,BackGround)
 Graphics.primitive_SetColor(50,0,0,0,BackGround)
 Graphics.primitive_SetSize(137,137,BackGround)

 JeunoPic1=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset+2,yOffset+2,JeunoPic1)
 Graphics.primitive_SetColor(255,255,255,255,JeunoPic1)
 Graphics.primitive_SetSize(24,24,JeunoPic1)
 Graphics.primitive_SetTexture("Airship/jeuno.jpg",JeunoPic1)

 ArrowPic1=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset+29,yOffset+2,ArrowPic1)
 Graphics.primitive_SetColor(255,255,255,255,ArrowPic1)
 Graphics.primitive_SetSize(24,24,ArrowPic1)
 Graphics.primitive_SetTexture("Airship/arrow.jpg",ArrowPic1)

 AirshipPic=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset+56,yOffset+2,AirshipPic)
 Graphics.primitive_SetColor(255,255,255,255,AirshipPic)
 Graphics.primitive_SetSize(24,24,AirshipPic)
 Graphics.primitive_SetTexture("Airship/airship.jpg",AirshipPic)

 ArrowPic2=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset+83,yOffset+2,ArrowPic2)
 Graphics.primitive_SetColor(255,255,255,255,ArrowPic2)
 Graphics.primitive_SetSize(24,24,ArrowPic2)
 Graphics.primitive_SetTexture("Airship/arrow.jpg",ArrowPic2)

 JeunoPic2=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset+110,yOffset+2,JeunoPic2)
 Graphics.primitive_SetColor(255,255,255,255,JeunoPic2)
 Graphics.primitive_SetSize(24,24,JeunoPic2)
 Graphics.primitive_SetTexture("Airship/jeuno.jpg",JeunoPic2)

 WindyPic=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset+56,yOffset+29,WindyPic)
 Graphics.primitive_SetColor(255,255,255,255,WindyPic)
 Graphics.primitive_SetSize(24,24,WindyPic)
 Graphics.primitive_SetTexture("Airship/windy.jpg",WindyPic)

 SandyPic=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset+56,yOffset+56,SandyPic)
 Graphics.primitive_SetColor(255,255,255,255,SandyPic)
 Graphics.primitive_SetSize(24,24,SandyPic)
 Graphics.primitive_SetTexture("Airship/sandy.jpg",SandyPic)

 BastokPic=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset+56,yOffset+83,BastokPic)
 Graphics.primitive_SetColor(255,255,255,255,BastokPic)
 Graphics.primitive_SetSize(24,24,BastokPic)
 Graphics.primitive_SetTexture("Airship/bastok.jpg",BastokPic)

 KazhamPic=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset+56,yOffset+110,KazhamPic)
 Graphics.primitive_SetColor(255,255,255,255,KazhamPic)
 Graphics.primitive_SetSize(24,24,KazhamPic)
 Graphics.primitive_SetTexture("Airship/kazham.jpg",KazhamPic)
end


function GetSchedule(Column)
 local now = os.time()
 local elapsedTime = math.mod(now * 1000 - BasisDate * 1000, msGameDay) + 144000
 local vTime = ((898 * 360 + 30) * msRealDay + FixTime*1000) + (now * 1000 - BasisDate * 1000) * 25
 local vDay = math.floor(math.mod(vTime, 8 * msRealDay) / msRealDay) + 1
 local offset1 = ((1 * 60) + 10) * 60 * 1000 / 25 -- 1:10 B->J J->S
 local offset2 = ((2 * 60) + 40) * 60 * 1000 / 25 -- 2:40 J->W K-J
 local offset3 = ((4 * 60) + 10) * 60 * 1000 / 25 -- 4:10 J->B S->J
 local offset4 = ((5 * 60) + 35) * 60 * 1000 / 25 -- 5:35 J->K
 local offset5 = ((5 * 60) + 45) * 60 * 1000 / 25 -- 5:45 W->J
 local outAir = string.format("%s","")

 if Column==1 then
   outAir = outAir .. ASHelper(elapsedTime, offset2, vDay)
   outAir = outAir .. "\n"
   outAir = outAir .. ASHelper(elapsedTime, offset1, vDay)
   outAir = outAir .. "\n"
   outAir = outAir .. ASHelper(elapsedTime, offset3, vDay)
   outAir = outAir .. "\n"
   outAir = outAir .. ASHelper(elapsedTime, offset4, vDay)
 else
   outAir = outAir .. ASHelper(elapsedTime, offset5, vDay)
   outAir = outAir .. "\n"
   outAir = outAir .. ASHelper(elapsedTime, offset3, vDay)
   outAir = outAir .. "\n"
   outAir = outAir .. ASHelper(elapsedTime, offset1, vDay)
   outAir = outAir .. "\n"
   outAir = outAir .. ASHelper(elapsedTime, offset2, vDay)
 end
 return outAir
end

function HotKeyCheck()
 if Windower.script_GetCommandCount()>0 then
   for i=1,Windower.script_GetCommandCount(),1 do
     Command[i]=Windower.script_GetCommand() --ignore all extra commands
   end
   DynamicFunction=_G[Command[1]] --execute first command only
   DynamicFunction()
 end
end  

function ASHelper(Elapsed, Offset, Day)
 local newOffset = Offset;
 local count = 0
 while (newOffset < Elapsed) do
   count = count + 1
   newOffset = newOffset + (msGameDay / 4)
 end
 if (count >= 4) then Day = math.mod(Day + 1, 8) end
 local arrivalTime = newOffset - Elapsed - 144000
 if (arrivalTime < 0) then arrivalTime = 0 end
 local s = string.format("%s\n",padstring(formatTime(newOffset-Elapsed),8))
 return s
end

function padstring(s,len)
 if string.len(s) > len then return s end
 s = s .. string.rep(" ",len-string.len(s))
 return s
end

function formatTime(t)
 local hourLeft = (t / msRealDay - math.floor(t / msRealDay)) * 24
 local minLeft = (hourLeft - math.floor(hourLeft)) * 60
 local secLeft = (minLeft - math.floor(minLeft)) * 60
 return string.format("%02d:%02d",math.floor(minLeft),secLeft)
end

function Unload()
 Quit = 1
end

function CloseOut()
 Control.control_UnbindKey(CloseHotKey,true,false,false)
 if Windower.script_GetCommandCount()>0 then
   for i=2,Windower.script_GetCommandCount(),1 do
     Command[i]=Windower.script_GetCommand() --ignore all extra commands
   end
 end
 Graphics.primitive_DeleteAll()
 Graphics.text_DeleteAll()
end

-- Main --

Initialize()

while Quit==0 do
 TextColumn = 1
 Output = string.format("\n%s\n",GetSchedule(TextColumn))
 Graphics.text_SetText(Output,Text1)
 TextColumn = 2
 Output = string.format("\n%s\n",GetSchedule(TextColumn))
 Graphics.text_SetText(Output,Text2)

 HotKeyCheck()
 
 Windower.script_Sleep(100)
end

CloseOut()


Screenshot:

fbs.freewebspace.com/cgi-bin/i/Airship_Shot.jpg

There we go. Let me know what you think, and thanks in advance for looking over it.

[X-Drop]

Sup JimmyTime!

Grats on first script, lemme see if I can answer a few questions for you.

1.) Object Layer Order: Don't think this is gonna get fixed any time soon unless someone steps up to the plate. Check out these links:
Z-position
Direct 3D help needed

2.) # of text/image objects: After looking at your text objects I see you don't have any repeatitive objects with similar names. In that case, you could make a function that you pass variables to (name, size, color, etc.) and have it create and set up the object for you. You might even have to define a couple of things as globals. Honestly, it would be more complicated than just defining each object seperately.

3.) Speed/Variable Issues: The reason to limit a variable to local scope, is because it will only be needed within a function or do block end. Why use memory to store a useless variable. Though I have only just begun to use locals myself.

4.) Image Problems: You should use the Lunar function primitive_SetFitToTexture. Reread the Lunar docs for a full explaination of it's use.

5.) If/Then Question: I'll let Nebula answer that.

6.) Advanced Key Binding: You can bind a key with ctrl and/or alt. Again, reread the Lunar docs details.

Good luck!

[Jimmytime]

Thanks for the quick reply, X ^^

1.) Object Layer Order - Makes sense. I saw a similar post on the subject but now I know how deep in the problem is. No biggie, I can use the semi-transparent background indefinitely.

2.) # of text/image objects - Agreed, the code readability would only slightly[i/] benefit from adding a creation function. I think I might do it anyway for the practice and to continue cleaning the cobwebs out of the programming language portion of my brain :^P

3.) Speed/Variable Issues - I definitely see what you mean. As a follow-up, should the constant re-creation of these local variables slow down the script by any noticable degree? Reason I ask is if so, I'd move them to globals so they're only created once. But then again I seem to remember way back someone telling me there's more time/commands needed to pass a global into a function on some languages.

4/6.) Image Problems/Advanced Key Binding - Whoops! I must've read over the Lunar documentationa bit too early in my research, and haven't come back to it since the beginning. I'd definitely pour over it again now, since 2 of my questions could've been answered there.

5.) If/Then Question - Fair enough, plus I'll try re-reading a generic lua document tonight to see if I can catch it myself. I threw that Q in there at the last minute, hehe.

Thanks again for the comments! I'll post the next iteration soon after I clean it up ^^

[X-Drop]

should the constant re-creation of these local variables slow down the script by any noticable degree?

Nope.

Here is a copy/paste from lua-users.org/wiki/ScopeTutorial,

Because of the implementation of Lua it is more efficient to use local variables wherever possible. The technical reason for this is that local variables are referenced via an assigned number, whereas global variables are stored in a table which is accessed with a key (the variable name). Table lookups are very fast in Lua, but still not as fast as local register lookups.

If the following code is compiled we can look at the Lua virtual machine instructions outputted.

g = "global"
local l = "local"
print(g,l)

The command line tool luac (Lua compiler) can be used to compile the code, which gives:

main <a.lua:0> (8 instructions, 32 bytes at 00355578)
0 params, 4 stacks, 0 upvalues, 1 local, 4 constants, 0 functions
1 [2] LOADK 0 1 ; "global"
2 [2] SETGLOBAL 0 0 ; g
3 [4] LOADK 0 2 ; "local"
4 [6] GETGLOBAL 1 3 ; print
5 [6] GETGLOBAL 2 0 ; g
6 [6] MOVE 3 0 0
7 [6] CALL 1 3 1
8 [6] RETURN 0 1 0

We won't go into great detail about what is going on here but you can see that the variables g and l are treated differently, with access to locals being more immediate.

[TinyTerror]

Yeah, local variables are very quick to recreate. Don't fall into the trap of using alot of global variables. Besides the performance impact mentioned by x-drop, overuse of globals is considered bad form in almost all programming languages.

[Jimmytime]

Ahh nice, that clears up exactly what I was thinking about, thanks guys :^)

Yeah I'd definitely prefer to use less globals anyway, so good ^^

[X-Drop]

I'm just now begining to fully understand when to leave a variable as global and when to define it as local. I completely ignored this point for the last month and a half.

[TinyTerror]

In small scripts such as the ones most of you are making, the use of globals isn't that bad. Over use of globals will get you in trouble when you have larger codebases. Because the variable is global, it can be modified anywhere, making it really hard to figure out where changes are taking place. This is one of those things you only really run into after alot of practice.

[X-Drop]

2.) # of text/image objects: After looking at your text objects I see you don't have any repeatitive objects with similar names. In that case, you could make a function that you pass variables to (name, size, color, etc.) and have it create and set up the object for you. You might even have to define a couple of things as globals. Honestly, it would be more complicated than just defining each object seperately.

Ok, I went ahead and put this idea into action because I was curious to see it's performance.

---

My first attempt produced a function with a set number of arguments.

function txt_obj(create, name, index, show, x, y, font, size, bold, italic, alpha, red, green, blue, text)

This function works just fine. You can use it to create a new text object or simply redefine an existing object. This function will allow for indexing of text objects as well. The downside to this function is that the number of arguments are fixed. Meaning you would have to set arguments to nil if you are not using them. And thats a drag. Plus you need to list the arguments in the same abritrary order each time...create, name, index, show, x, y, etc... It's a bit constraining.

The next attempt was much more appealling. Here is a function with a variable number of arguments.

function txt_obj(arguments) -- optional arguments: name, create, index, show, x, y, font, size, italic, bold, alpha, red, green, blue, text

The beauty of this function is that you can call any number of arguments and list them in any order. This is accomplished by sending the arguments in a table as key, value pairs. When the function recieves the argument table, it unpacks the key, value pairs and allows them to be used within the function. To me, this function is very readable and easily implimented into a script.

But, alas we test the functions for performance...

Of coarse the normal method of defining text objects will always be the fastest. Though certainly not the most readable when jammed into a script.

The next best performer was actually my first attempt. But I really dislike the strict order in which the arguments must be defined.

The slowest of the bunch it the variable arg function. The reason I suppose is that Lua has to unpack the argument table before it can apply the arguments.

---

Here is a script you can run to compare the three methods described. The script compares the methods in two tests.

• The first test creates a column of 75 rows of new text objects. The speeds are somewhat similar here, but the normal method is still the fastest.
  
• The second test is a quick color change on all the text objects. Here is where you can clearly see the difference in speeds.
  

The Verdict: lol... I'll probably just continue to define my text objects the normal way!

-- Created by X-Drop     January 2006

function method1(arguments)  -- optional arguments: name, create, index, show, x, y, font, size, italic, bold, alpha, red, green, blue, text
--------------------------------------------------------------------------------------------------------
 for key, value in pairs(arguments) do _G[key] = value end
 
 if index then
   if create then _G[name][index] = Graphics.text_CreateObject() end
   if x and y then Graphics.text_SetPosition(x, y, _G[name][index]) end
   if font and size then Graphics.text_SetFont(font, size, _G[name][index]) end
   if bold then Graphics.text_SetBold(bold, _G[name][index]) end
   if italic then Graphics.text_SetItalic(italic, _G[name][index]) end
   if alpha and red and green and blue then Graphics.text_SetColor(alpha, red, green, blue, _G[name][index]) end
   if show then Graphics.text_SetVisibility(show, _G[name][index]) end
   if text then Graphics.text_SetText(text, _G[name][index]) end
 else
   if create then _G[name] = Graphics.text_CreateObject() end
   if x and y then Graphics.text_SetPosition(x, y, _G[name]) end
   if font and size then Graphics.text_SetFont(font, size, _G[name]) end
   if bold then Graphics.text_SetBold(bold, _G[name]) end
   if italic then Graphics.text_SetItalic(italic, _G[name]) end
   if alpha and red and green and blue then Graphics.text_SetColor(alpha, red, green, blue, _G[name]) end
   if show then Graphics.text_SetVisibility(show, _G[name]) end
   if text then Graphics.text_SetText(text, _G[name]) end
 end
 
 name, create, index, show, x, y, font, size, italic, bold, alpha, red, green, blue, text = nil
--------------------------------------------------------------------------------------------------------
end

function method2(create, name, index, show, x, y, font, size, bold, italic, alpha, red, green, blue, text)
--------------------------------------------------------------------------------------------------------
 if index then
   if create then _G[name][index] = Graphics.text_CreateObject() end
   if x and y then Graphics.text_SetPosition(x, y, _G[name][index]) end
   if font and size then Graphics.text_SetFont(font, size, _G[name][index]) end
   if bold then Graphics.text_SetBold(bold, _G[name][index]) end
   if italic then Graphics.text_SetItalic(italic, _G[name][index]) end
   if alpha and red and green and blue then Graphics.text_SetColor(alpha, red, green, blue, _G[name][index]) end
   if show then Graphics.text_SetVisibility(show, _G[name][index]) end
   if text then Graphics.text_SetText(text, _G[name][index]) end
 else
   if create then _G[name] = Graphics.text_CreateObject() end
   if x and y then Graphics.text_SetPosition(x, y, _G[name]) end
   if font and size then Graphics.text_SetFont(font, size, _G[name]) end
   if bold then Graphics.text_SetBold(bold, _G[name]) end
   if italic then Graphics.text_SetItalic(italic, _G[name]) end
   if alpha and red and green and blue then Graphics.text_SetColor(alpha, red, green, blue, _G[name]) end
   if show then Graphics.text_SetVisibility(show, _G[name]) end
   if text then Graphics.text_SetText(text, _G[name]) end
 end
--------------------------------------------------------------------------------------------------------
end

Text_A = {}
Text_B = {}
Text_C = {}

-----create text objects using three different methods-----

--method 1--
method1({name="Text_A", create=1, index=0, show=1, x=100, y=0, font="Arial", size=12, bold=1, alpha=255, red=255, green=200, blue=0, text="method 1"})

for i = 1, 75, 1 do
 method1({name="Text_A", create=1, index=i, show=1, x=100, y=(i*13), font="Arial", size=12, bold=1, alpha=255, red=255, green=200, blue=0, text=i})
end


--method 2--
method2(1, "Text_B", 0, 1, 400, 0, "Arial", 12, 1, 0, 255, 255, 200, 0, "method 2")

for i = 1, 75, 1 do
 method2(1, "Text_B", i, 1, 400, i*13, "Arial", 12, 1, 0, 255, 255, 200, 0, i)
end


--method 3--
Text_C[0] = Graphics.text_CreateObject()
Graphics.text_SetPosition(700, 0, Text_C[0])
Graphics.text_SetColor(255, 255, 200, 0, Text_C[0])
Graphics.text_SetFont("Arial", 12, Text_C[0])
Graphics.text_SetBold(1, Text_C[0])
Graphics.text_SetText("normal method", Text_C[0])

for i = 1, 75, 1 do
 Text_C[i] = Graphics.text_CreateObject()
 Graphics.text_SetPosition(700, i*13, Text_C[i])
 Graphics.text_SetColor(255, 255, 200, 0, Text_C[i])
 Graphics.text_SetFont("Arial", 12, Text_C[i])
 Graphics.text_SetBold(1, Text_C[i])
 Graphics.text_SetText(i, Text_C[i])
end

Windower.script_Sleep(3000)

-----change text objects using three different methods-----

--method 1--
for i = 0, 75, 1 do
 method1({name="Text_A", index=i, italic=1, alpha=255, red=255, green=0, blue=0})
end

--method 2--
for i = 0, 75, 1 do
 method2(nil, "Text_B", i, nil, nil, nil, nil, nil, nil, 1, 255, 255, 0, 0, nil)
end

--method 3--
for i = 0, 75, 1 do
 Graphics.text_SetColor(255, 255, 0, 0, Text_C[i])
 Graphics.text_SetItalic(1, Text_C[i])
end

Windower.script_Sleep(3000)

-- end of script --

[Jimmytime]

Wow X, nice, very thorough ^^ After a little more practice, I'm tending to agree with you that its just easier to create each one explicitly.

Here's my updated script:


-- Airship.lua
-- Version: 0.8
-- 01/20/05
-- By: JimmyTime
-- Purpose: Displays the departure schedule for airships

function Initialize()
 Windower.script_SetAuthor("JimmyTime")
 Windower.script_SetVersion("0.8")
 Windower.script_SetContact("http://tinyterror.proboards37.com")
 Windower.script_SetName("Airship.lua")
 
 GMTOffset = -5
 FixTime = 15*60

 xOffset = 2
 yOffset = 300

 Command={}
 Quit = 0
 TextColumn = 1
 
 BasisDate = os.time{year=2002, month=6, day=23, hour=16+GMTOffset, min=0, sec=0}
 MoonDate = os.time{year=2004, month=1, day=25, hour=2+GMTOffset, min=31, sec=12}

 VanaDayList = {"Earthsday", "Watersday", "Windsday", "Iceday", "Lightningday", "Lightsday", "Darksday","Firesday"}

 msGameDay = (24 * 60 * 60 * 1000 / 25) --milliseconds in a game day
 msRealDay = (24 * 60 * 60 * 1000) --milliseconds in a real day
 
 SetupGraphics()
 
 UnbindHotKeys()
 
 Control.control_BindKey("F1",true,false,false,".Lunar command Airship.lua Unload")
end

function SetupGraphics()
 Text1 = Graphics.text_CreateObject()
 Graphics.text_SetPosition(xOffset+11,yOffset+14,Text1)
 Graphics.text_SetColor(255,255,255,255,Text1)
 Graphics.text_SetFont("Courier New",9,Text1)
 Graphics.text_SetBold(true,Text1)

 Text2 = Graphics.text_CreateObject()
 Graphics.text_SetPosition(xOffset+90,yOffset+14,Text2)
 Graphics.text_SetColor(255,255,255,255,Text2)
 Graphics.text_SetFont("Courier New",9,Text2)
 Graphics.text_SetBold(true,Text2)

 BackGround=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset,yOffset,BackGround)
 Graphics.primitive_SetColor(50,0,0,0,BackGround)
 Graphics.primitive_SetSize(137,137,BackGround)

 JeunoPic1=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset+2,yOffset+2,JeunoPic1)
 Graphics.primitive_SetColor(255,255,255,255,JeunoPic1)
 Graphics.primitive_SetSize(24,24,JeunoPic1)
 Graphics.primitive_SetFitToTexture(false,JeunoPic1)
 Graphics.primitive_SetTexture("Airship/jeuno.jpg",JeunoPic1)

 ArrowPic1=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset+29,yOffset+2,ArrowPic1)
 Graphics.primitive_SetColor(255,255,255,255,ArrowPic1)
 Graphics.primitive_SetSize(24,24,ArrowPic1)
 Graphics.primitive_SetFitToTexture(false,ArrowPic1)
 Graphics.primitive_SetTexture("Airship/arrow.png",ArrowPic1)
 
 AirshipPic=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset+56,yOffset+2,AirshipPic)
 Graphics.primitive_SetColor(255,255,255,255,AirshipPic)
 Graphics.primitive_SetSize(24,24,AirshipPic)
 Graphics.primitive_SetFitToTexture(false,AirshipPic)
 Graphics.primitive_SetTexture("Airship/airship.jpg",AirshipPic)
 
 ArrowPic2=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset+83,yOffset+2,ArrowPic2)
 Graphics.primitive_SetColor(255,255,255,255,ArrowPic2)
 Graphics.primitive_SetSize(24,24,ArrowPic2)
 Graphics.primitive_SetFitToTexture(false,ArrowPic2)
 Graphics.primitive_SetTexture("Airship/arrow.png",ArrowPic2)
 
 JeunoPic2=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset+110,yOffset+2,JeunoPic2)
 Graphics.primitive_SetColor(255,255,255,255,JeunoPic2)
 Graphics.primitive_SetSize(24,24,JeunoPic2)
 Graphics.primitive_SetFitToTexture(false,JeunoPic2)
 Graphics.primitive_SetTexture("Airship/jeuno.jpg",JeunoPic2)
 
 WindyPic=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset+56,yOffset+29,WindyPic)
 Graphics.primitive_SetColor(255,255,255,255,WindyPic)
 Graphics.primitive_SetSize(24,24,WindyPic)
 Graphics.primitive_SetFitToTexture(false,WindyPic)
 Graphics.primitive_SetTexture("Airship/windy.jpg",WindyPic)
 
 SandyPic=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset+56,yOffset+56,SandyPic)
 Graphics.primitive_SetColor(255,255,255,255,SandyPic)
 Graphics.primitive_SetSize(24,24,SandyPic)
 Graphics.primitive_SetFitToTexture(false,SandyPic)
 Graphics.primitive_SetTexture("Airship/sandy.jpg",SandyPic)
 
 BastokPic=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset+56,yOffset+83,BastokPic)
 Graphics.primitive_SetColor(255,255,255,255,BastokPic)
 Graphics.primitive_SetSize(24,24,BastokPic)
 Graphics.primitive_SetFitToTexture(false,BastokPic)
 Graphics.primitive_SetTexture("Airship/bastok.jpg",BastokPic)
 
 KazhamPic=Graphics.primitive_CreateObject()
 Graphics.primitive_SetPosition(xOffset+56,yOffset+110,KazhamPic)
 Graphics.primitive_SetColor(255,255,255,255,KazhamPic)
 Graphics.primitive_SetSize(24,24,KazhamPic)
 Graphics.primitive_SetFitToTexture(false,KazhamPic)
 Graphics.primitive_SetTexture("Airship/kazham.jpg",KazhamPic)
end

function getAirSchedule()
 local now = os.time()
 local elapsedTime = math.mod(now * 1000 - BasisDate * 1000, msGameDay) + 144000

 local vTime = ((898 * 360 + 30) * msRealDay + FixTime*1000) + (now * 1000 - BasisDate * 1000) * 25
 local vDay = math.floor(math.mod(vTime, 8 * msRealDay) / msRealDay) + 1

 local offset1 = ((1 * 60) + 10) * 60 * 1000 / 25 -- 1:10 offset used by B->J J->S
 local offset2 = ((2 * 60) + 40) * 60 * 1000 / 25 -- 2:40 offset used by J->W K-J
 local offset3 = ((4 * 60) + 10) * 60 * 1000 / 25 -- 4:10 offset used by J->B S->J
 local offset4 = ((5 * 60) + 35) * 60 * 1000 / 25 -- 5:35 offset used by J->K
 local offset5 = ((5 * 60) + 45) * 60 * 1000 / 25 -- 5:45 offset used by W->J

 local outAir = string.format("%s","")

 if TextColumn == 1 then
   outAir = outAir .. ASHelper(elapsedTime, offset2, vDay)
   outAir = outAir .. "\n"
   outAir = outAir .. ASHelper(elapsedTime, offset1, vDay)
   outAir = outAir .. "\n"
   outAir = outAir .. ASHelper(elapsedTime, offset3, vDay)
   outAir = outAir .. "\n"
   outAir = outAir .. ASHelper(elapsedTime, offset4, vDay)
 else
   outAir = outAir .. ASHelper(elapsedTime, offset5, vDay)
   outAir = outAir .. "\n"
   outAir = outAir .. ASHelper(elapsedTime, offset3, vDay)
   outAir = outAir .. "\n"
   outAir = outAir .. ASHelper(elapsedTime, offset1, vDay)
   outAir = outAir .. "\n"
   outAir = outAir .. ASHelper(elapsedTime, offset2, vDay)
 end
 return outAir
end

function ASHelper(Elapsed, Offset, Day)
 local newOffset = Offset;
 local count = 0
 while (newOffset < Elapsed) do
   count = count + 1
   newOffset = newOffset + (msGameDay / 4)
 end
 if (count >= 4) then
   Day = math.mod(Day + 1, 8)
 end

 local arrivalTime = newOffset - Elapsed - 144000
 if (arrivalTime < 0) then
   arrivalTime = 0
 end
 local s = string.format("%s\n",padstring(formatTime(newOffset-Elapsed),8))
 return s
end

function padstring(s,len)
 if string.len(s) > len then
   return s
 end
 s = s .. string.rep(" ",len-string.len(s))
 return s
end

function formatTime(t)
 local hourLeft = (t / msRealDay - math.floor(t / msRealDay)) * 24
 local minLeft = (hourLeft - math.floor(hourLeft)) * 60
 local secLeft = (minLeft - math.floor(minLeft)) * 60
 return string.format("%02d:%02d",math.floor(minLeft),secLeft)
end

function UnbindHotKeys()
 Control.control_UnbindKey("F1",true,false,false)
 if Windower.script_GetCommandCount()>0 then
   for i=2,Windower.script_GetCommandCount(),1 do
     Command[i]=Windower.script_GetCommand() --ignore all extra commands
   end
 end
end

function Unload()
 Quit=1
end

function HotKeyCheck()
 if Windower.script_GetCommandCount()>0 then
   for i=1,Windower.script_GetCommandCount(),1 do
     Command[i]=Windower.script_GetCommand() --ignore all extra commands
   end
   DynamicFunction=_G[Command[1]] --execute first command only
   DynamicFunction()
 end
end

Initialize()

while Quit == 0 do
 HotKeyCheck()
 
 TextColumn = 1
 Output = string.format("\n%s\n",getAirSchedule())
 Graphics.text_SetText(Output,Text1)
 TextColumn = 2
 Output = string.format("\n%s\n",getAirSchedule())
 Graphics.text_SetText(Output,Text2)

 Windower.script_Sleep(500)
end

UnbindHotKeys()
Graphics.primitive_DeleteAll()
Graphics.text_DeleteAll()


Screenshot:

fbs.freewebspace.com/AirshipProgress2.jpg

Question Resolutions:

1.) Object Layer Order - On Hold.

2.) # of Text/Image Objects - Solved. I'm just going to create them explicitly and get on with other matters.

3.) Speed/Variable Issues - Solved. I'll watch my globals and define locals when possible.

4.) Image Problems - Solved. Besides using the fit function, I also see that you should use it before you set an image into the primative.

5.) If/Then Question - Solved. Since my variable was global anyway, I eliminated the passing to the function, and init'd it, and everything works fine now.

6.) Key Binding - Added. The F1 key now closes the script.

Follow-Up Questions:

1.) Key Binding - Say I bind a key in Windower to ".Lunar load airship.lua" to start up my script. Is it "kosher" to unbind that key through my script, bind it to my closeout command inside the script, and then, as I'm exiting, re-bind it to load the lunar script again? I think its fine, but I guess the real question is "Do Windower and Lunar share the same bind data?"

2.) Init File - Before I release this on the actual script area, I'd like to add an "airship.ini" file to make editing of the startup variables easier on a casual user (once again, mostly for practice). I'm always a fan of seeing how others have done something, so do you guys know of a script posted around here that has at least one variable being passed from an ini file so I could see the usage by example? If not no biggie, I'll just fiddle with it myself until I figure it out.

3.) Suggestions - Do you guys have any suggestions for cleanup/changes before I make this V1.0? Keeping in mind the intent of the script is to display a minimal/graphical airship departure-only schedule to and from the cities. Any suggestions to make it a lil' slicker? (not that it needs to be, but its nice to have possible ideas tossed around)

4.) Random Q - Anyone know of a better way to represent Kazham with an icon than an unreadable map shot like I have now? My only other idea was the icon for a Kazham Pineapple ^^

--Jim--

[X-Drop]

1.) Key Binding: Good question... but I dunno know.

2.) Init File: I'm just now getting comfortable with multiple files for one script. All the scripts I did up until now, I just jammed eveything into a single file. So I don't have any working examples to show you. But maybe this can help get you started,

function Lunar_path()
--------------------------------------------------------------------------------------------------------
local i, j = string.find(debug.getinfo(Lunar_path).source, "Lunar\\scripts\\")
return string.sub(debug.getinfo(Lunar_path).source, 2, j)
--------------------------------------------------------------------------------------------------------
end


function get_ini()
--------------------------------------------------------------------------------------------------------
local file = assert(io.open(Lunar_path() .. "Airship.ini", "r"))
local contents = file:read("*all")
assert(file:close())

-- add string.find here for various settings??
-- example: local _, _, xOffset = string.find(contents, "xOffset=%s*(%d+)")

return xOffset, arg2,arg3, ect...
--------------------------------------------------------------------------------------------------------
end

I dunno, maybe lose the return and just allow the xOffset to be global when you use string.find. Whatever works for you.

[Jimmytime]

Thanks X that's exactly the jump start I was looking for ^^

I think the binding thing will work, and plan to try it unless I hear otherwise from Tiny first.

[nebula]

you know you can jes put everything into another file and do

assert(loadfile(Lunar_path .. "Airship.ini")) ()

loadfile returns a function, if you call it, all the lua code in the included file is executed, hence the () after the assert (you're running the function anon)

so simply, it'll include everything in the ini

as far as the getinfo, it doesn't return the path >.> .source is just the source file name, not full path


function foo() end

for k,v in debug.getinfo(foo) do
print(k,v)
end


if run yields:


>bins/lua5.exe "foo.lua"
source @foo.lua
what Lua
func function: 003278C8
name foo
nups 0
currentline -1
namewhat global
linedefined 1
short_src foo.lua

[sdphantom]

nebula said:

you know you can jes put everything into another file and do

assert(loadfile(Lunar_path .. "Airship.ini")) ()

loadfile returns a function, if you call it, all the lua code in the included file is executed, hence the () after the assert (you're running the function anon)

so simply, it'll include everything in the ini

You can also use the dofile() function to immediately include another lua script.

nebula said:

as far as the getinfo, it doesn't return the path >.> .source is just the source file name, not full path


function foo() end

for k,v in debug.getinfo(foo) do
print(k,v)
end


if run yields:


>bins/lua5.exe "foo.lua"
source @foo.lua
what Lua
func function: 003278C8
name foo
nups 0
currentline -1
namewhat global
linedefined 1
short_src foo.lua

debug.getinfo().source returns whatever was passed to the interpreter. With Lunar, it does specify the absolute path as with your example (Lua5.exe) returns the relative path. Whether absolute or relative, it does return the path of the script.

I've had this approach work in a few scripts, including my recently released MultiTimer script.

[nebula]

ahso i've jes gone from the documentation which says source --- Where the function was defined. If the function was defined in a string (through loadstring), source is that string. If the function was defined in a file, source is the file name prefixed with a `@´.