Rombot feature request - Userfunctions file

[rock5]

Hi,

I just had an idea.

I've gotten to the point that I create routines that do certain tasks and cut and paste them to waypoints as needed which can make waypoints quite large.

I thought I'd like to make them in to functions but I gather I would have to edit one of the exiting files to include my functions. This would cause problems when updating to the latest svn.

It would be great if users could create their own functions and keep them in their own userfunctions file to use in their waypoint files as needed.

The exciting part of this idea is it would allow an easy way for users to help each other by sharing their functions, that complete specific tasks, with other users. It would encourage more user participation. You could have a forum dedicated to user created functions. If people need help to complete a specific task they could go there copy and paste a solution into their userfunctions files. Then they could use it in their scripts.

And who knows, maybe you'll see a function that needs to be added to the main files of the rombot.?

What do you think? I believe it would be very simple to implement, wouldn't it? Just a matter of including the userfunctions file if it exists.

[Administrator]

If you're updating off of SVN, you can merge your changes with updates so that you don't lose them. That's the whole reason behind SVN. Also, you could just create a new file named 'myfunctions.lua', and then add 'include("myfunctions.lua")' to rom/bot.lua.

[rock5]

The reason I don't like to make changes to the regular files of rombot is because sometimes the changes I want to make are specific to my needs and they might conflict with future versions.

Thanks for telling me where to put the 'myfunctions.lua'. I'd seen 'include' commands in various files and didn't know if just putting it in the bot.lua would be enough. I'm doing that now.

So I take it you weren't as excited by the idea as me? I just thought if you made it a part if rombot it would stimulate user participation.

To give you an example, here are the first functions I'm adding;

Code: Select all

------------------------------------------------
-- Dismount Script
-- mountsbuff = name of mount as appears in player buffs
-- returns 'true' if the player dismounted or 'false' if not.
------------------------------------------------
function CancelBuff(buffname)
    if mountsbuff == nil then
        cprintf(cli.yellow,"No mount specified. Please use 'CancelBuff(buffname)'.\n")
        return false
    end
    local buffnum=1
    local buff=RoMScript("UnitBuff('player',"..buffnum..")");
    while buff ~= nil do
        if buff == buffname then
            sendMacro("CancelPlayerBuff("..buffnum..");")
            return true
        end
        buffnum=buffnum+1
        buff=RoMScript("UnitBuff('player',"..buffnum..")");
    end
    return false
end

------------------------------------------------
-- Select Option By Name
-- optiontext = option text or part of
-- NPC option dialog should already be open
------------------------------------------------
function SelectOptionByName(optiontext)
    counter = 1
    while RoMScript("GetSpeakOption("..counter..")") do
        if string.find(RoMScript("GetSpeakOption("..counter..")"),optiontext) then
            sendMacro("ChoiceOption("..counter..");"); yrest(1500);
            return true
        end
        counter = counter +1
    end
    return false
end

------------------------------------------------
-- Buy number of items by item name
-- itemname = name of item to buy
-- num = number of items to buy
-- Store should already be open
------------------------------------------------
function BuyItemByName(itemname, num)
    if num == nil then num = 1 end -- Assume you want to buy 1

    counter = 1
    icon, name = RoMScript("GetStoreSellItemInfo("..counter..")")
    while name do
        if string.find(name,itemname) then
            for i = 1, num do
                sendMacro("StoreBuyItem("..counter..")"); yrest(1000);
            end
            return true
        end
        counter = counter + 1
        icon, name = RoMScript("GetStoreSellItemInfo("..counter..")")
    end
    return false
end

[Administrator]

I've added a conditional include (see below) to include the file if it exists, but have not committed it to the SVN repository yet. I will not make a default userfunctions.lua file for the reason that installing a newer version would overwrite the users' copy in the future. Basically, the file will still need to be created by the user to prevent upgrade issues.

Code: Select all

if( fileExists("userfunctions.lua") ) then
	include("userfunctions.lua");
end

[rock5]

Yep, that's the way I was expecting it to work.

Please do commit it. I think maybe I will start a thread so users know about it and can start using it, unless you want to do it?

1 last question I've been meaning to ask, what is the difference between the solarstrike and elitepvpers forums? When should users use 1 or the other?

[Administrator]

It was committed.

1 last question I've been meaning to ask, what is the difference between the solarstrike and elitepvpers forums? When should users use 1 or the other?

This is the official forum. If you have technical problems, it's probably better to post here. If you don't speak English, it's probably best to post on elitepvpers.

[rock5]

It doesn't work. Looks like fileExists command is wrong.

Can you please change it to:

Code: Select all

if( fileExists(getExecutionPath().."/userfunctions.lua") ) then

Thanks.

[Administrator]

It doesn't work. Looks like fileExists command is wrong.

Can you please change it to:

Code: Select all

if( fileExists(getExecutionPath().."/userfunctions.lua") ) then

Thanks.

Good catch. It's committed.

[rock5]

So is it ok for me to start a thread informing users about this and encouraging them to contribute functions?

If so should I do it here at solarstrike?

[Administrator]

So is it ok for me to start a thread informing users about this and encouraging them to contribute functions?

If so should I do it here at solarstrike?

That would be fine. A mention in the wiki would also be useful.