Xenobot Lua Documentation

Xenobot Lua Documentation

Documentation is hosted at wikia site.

http://xenobot.wikia.com/wiki/Documentation

Summary

SELF CLASS ITEM CLASS CONTAINER CLASS CREATURE CLASS CLIENT CLASS CAVEBOT CLASS LOOTER CLASS TARGETING CLASS WALKER CLASS CHANNEL CLASS MAP CLASS MODULE CLASS SIGNAL CLASS PROXY CLASS HEAD UP DISPLAY CLASS GLOBAL CLASS

-----

-----

-----

-----

-----

-----

-----

-----

-----

-----

-----

Well, good job

Quote:

---

Originally Posted by Rydan

Every function is explained in the default XenoBot lua library file so this thread is not needed.
I was also working on it a while ago but then Syntax came up with the file documentation.

---

Not everyone is even able to find the library. Honestly I think this is great for the community that wants to see what functions are available.
/Stusse

Quote:

---

Originally Posted by Rydan

Every function is explained in the default XenoBot lua library file so this thread is not needed.
I was also working on it a while ago but then Syntax came up with the file documentation.

---

Not every function is explained. In the other thread we were discussing about this documentation, Syntax and Spectrus approved this idea, but now seems that someone have deleted that thread.

@DarkstaR

It's done. Some functions weren't added like "libOnLocalSpeech", "libDestroyTimer" and similar. Let me know if this is helpful and if it should be edited.

Fine with me as long as it's updated. PM me a copy of the lua parser I sent if you modified it, please. Thread stuck.

Quote:

---

Originally Posted by Ropiderz

Self.ShopBuyItem(item, amount)


Buy the amount of items you want.


parameter item The item name or ID you want to buy.
parameter amount The amount of items you want to buy.
returns integer, integer

---

I might be wrong, but this one isn't working without @Forgee's library.
Correct me if I'm wrong.

Quote:

---

Originally Posted by Syntax

Fine with me as long as it's updated. PM me a copy of the lua parser I sent if you modified it, please. Thread stuck.

---

Ok

Quote:

---

Originally Posted by Bushu

I might be wrong, but this one isn't working without Forgee's library.
Correct me if I'm wrong.

---

All info was taken from the XenoLuaLib.lua, DarkstaR posted a while ago a list of issues with Forgee's lib, including this one you mentioned, but now it's part of native library.

Quote:

---

Originally Posted by Ropiderz

All info was taken from the XenoLuaLib.lua, DarkstaR posted a while ago a list of issues with Forgee's lib, including this one you mentioned, but now it's part of native library.

---

Good to know (:

Self.WithdrawItems(items array)

how can i specify the itemid, amount, bp where its at, bp to withdraw?

Quote:

---

Originally Posted by Sang

Self.WithdrawItems(items array)

how can i specify the itemid, amount, bp where its at, bp to withdraw?

---

The entry must be a table. Example:

lua code:

Self.WithdrawItems(FIRST_BACKPACK, {ITEM1, BACKPACK_INDEX, AMOUNT}, {ITEM2, BACKPACK_INDEX, AMOUNT}...)

The FIRST_BACKPACK is where to start searching for your items (optional), then you start the array:

{3031, 2} -- gold coin to the backpack index 2
{3031, 2, 50} -- move 50 coins instead of all

Hey man, great work. The majority of the community needs this.

Updated functions for the version 3.3.4

Added:

• Container.iContainers()
• Container:iItems()
  
• Creature.iCreatures()
• Creature.iAllies()
• Creature.iEnemies()
• Creature.iPartyMembers()
• Creature.iNpcs()
• Creature.iPlayers()
• Creature.iMonsters()
  
• Self.BrowseField(x, y, z)
• Self.PrivateMessage(player, message)
  

Changed:

• Existing classes that now can be called with the meta function __call, they are now cited as an Alternate Invocation for Class.New()
• As the Proxy functions doesn't return the same thing, I've added something on each example block so you know what they are returning.

Also I couldn't explain all the Creatures iterations because there's no enough space to add more functions on that post, so I've explained Creatures.iCreatures() and the others are cited on the same block.

Where do I download this XenoLuaLib.lua?

Quote:

---

Originally Posted by Golocky

Where do I download this XenoLuaLib.lua?

---

forget it I already found it in your signature

Quote:

---

Originally Posted by Golocky

forget it I already found it in your signature

---

That's my personal library, you don't need to download XenoLuaLib, it's already included on Xeno when you download it.

Fuck me.. You deserve a medal.

It seems that the Self.UseBed function doesn't work properly. It gets stuck at the 'Choose a Skill' window :(

Quote:

---

Originally Posted by robin

It seems that the Self.UseBed function doesn't work properly. It gets stuck at the 'Choose a Skill' window :(

---

Copy and paste your function

I love you, this is a lot more handy to me than the file that comes with xenobot. :)

@Syntax

I think I'll move it to wikia, so I can separate each function per page and add examples of usage, because it's hard to keep 15k characters on each post, otherwise in each update I'll need to delete others posts to keep the order. What do you think ?

example:

http://xenobot.wikia.com/wiki/Documentation

Quote:

---

Originally Posted by Ropiderz

@Syntax

I think I'll move it to wikia, so I can separate each function per page and add examples of usage, because it's hard to keep 15k characters on each post, otherwise in each update I'll need to delete others posts to keep the order. What do you think ?

example:

http://xenobot.wikia.com/wiki/Documentation

---

I think it sounds great :D

Quote:

---

Originally Posted by Ropiderz

@Syntax

I think I'll move it to wikia, so I can separate each function per page and add examples of usage, because it's hard to keep 15k characters on each post, otherwise in each update I'll need to delete others posts to keep the order. What do you think ?

example:

http://xenobot.wikia.com/wiki/Documentation

---

Fine by me.

Or maybe an increase in the maximum characters per post? But wikia looks sexy too :eek:

Well, I'm sticking it into wikia, to see documentation see this link: http://xenobot.wikia.com/wiki/Documentation

Quote:

---

Originally Posted by PromB

Copy and paste your function

---

Self.UseBed(32655, 31892, 2, TRAINING_SWORD)

So basically everything is done in the same way as in the example provided by DarkstaR in the changelog when the function was added.

No idea why this isn't working... :(

Could someone give me a simple example of how to recognise the input from a Channel please? I just cant seem to get it working correctly and the documentation on the wiki doesn't explain it.

I can't seem to figure out which variables should be within the anonymous function for the speech callback


Edit: Here's some code I made while trying to get it to work. I had a look through the XenoLuaLib file and it looks like when someone speaks the speech callback is called with a variable 'message', but it still seems to print blank in the server log.

Code:

---

ConfigChannel = {}

function ConfigChannel:new()
        local configChannel = {}
        local thisChannel = nil
       
        function configChannel:open(channelName)
                thisChannel = Channel.New(channelName, function(message) self:inputReceived(message) end, function() print("closed") end)
        end
       
        function configChannel:stop()
                thisChannel:Close()
        end
       
        function configChannel:inputReceived(message)
                print(message)
        end
       
        configChannel:open("Config")
       
        return configChannel
end

configChannel = ConfigChannel:new()

---

Here's the parts of the code from the XenoLuaLib file I'm referring to above:

Code:

---

function Channel:SpeakCallback(message)
    if (self._speakCallback == nil) then return 0 end
    return self._speakCallback(self, message)
end

---

Code:

---

function libOnCustomChannelSpeak(channel, message)
    for i, c in ipairs(libChannels) do
        if (c:ID() == math.floor(channel)) then
            c:SpeakCallback(message)
            break
        end
    end
end

---

Edit: Nevermind! I got it working after looking through the XenoLuaLib some more. I just needed another variable for the channel object. e.g.

Code:

---

        function configChannel:open(channelName)
                thisChannel = Channel.New(channelName, function(obj, message) self:inputReceived(message) end, function() print("closed") end)
        end

---

Thank you! It has worked perfectly!