[Home] [Downloads] [Search] [Help/forum]

Gammon Software Solutions forum

See www.mushclient.com/spam for dealing with forum spam. Please read the MUSHclient FAQ!

[Folder]  Entire forum
-> [Folder]  MUSHclient
. -> [Folder]  Lua
. . -> [Subject]  GetVariable from Plugin question
Home  |  Users  |  Search  |  FAQ
Username:
Register forum user name
Password:
Forgotten password?
(New message)
Subject: GetVariable from Plugin question
Name:
Your forum user name.
Register forum user name
Password:
Your forum password.
Forgotten password?
Message:
Message to be posted (in English, please).
Forum codes:
Check this if your message uses 'forum codes' or templates (auto-detected for new posts).
Forum codes Templates

Save this message ...

Subject review (reverse sequence)

Posted by Nick Gammon   Australia  (18,800 posts)  [Biography] bio   Forum Administrator
Date Fri 17 Sep 2010 11:45 PM (UTC)  [ quote  ]
Message
Check it out now.
- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top
Posted by Twisol   USA  (2,230 posts)  [Biography] bio
Date Fri 17 Sep 2010 11:21 PM (UTC)  [ quote  ]
Message
Ahh, good idea Nick!

I agree, moving the return value section to before the examples would be a lot better.
'Soludra' on Achaea

Blog: http://jonathan.com/
GitHub: http://github.com/Twisol
[Go to top] top
Posted by Erendir   Germany  (47 posts)  [Biography] bio
Date Fri 17 Sep 2010 11:20 PM (UTC)  [ quote  ]
Message
Exactly what i mean!

Maybe - i'm not sure - `Return value` before `Lua example` would be better.
[Go to top] top
Posted by Nick Gammon   Australia  (18,800 posts)  [Biography] bio   Forum Administrator
Date Fri 17 Sep 2010 10:55 PM (UTC)  [ quote  ]
Message
Erendir said:

I'm interested only in Lua examples.



He has a point. In version 4.62 I revamped the order so that Lua comes first (and the return codes next). I agree you usually have to scroll down to find the stuff you really want.

As an example of how it will look, I re-did the online version, so check this out:

http://www.gammon.com.au/scripts/doc.php?function=ColourNote
- Nick Gammon

www.gammon.com.au, www.mushclient.com
[Go to top] top
Posted by Erendir   Germany  (47 posts)  [Biography] bio
Date Fri 17 Sep 2010 10:44 PM (UTC)  [ quote  ]
Message
i do have the "Microsoft Help Workshop" (just got somewhere), but i have no idea how to compile the docgen from the source (downloaded from the first link in the http://gammon.com.au/forum/bbshowpost.php?id=8973 topic)
[Go to top] top
Posted by Twisol   USA  (2,230 posts)  [Biography] bio
Date Fri 17 Sep 2010 10:37 PM (UTC)  [ quote  ]
Message
Well, keep in mind: if you compile your own set of help files, you'll have to edit and recompile it every time Nick releases a new version with documentation changes.

Go to your start menu and look for an HTML Help Workshop folder. I think it comes with Windows by default, but frankly I'm not entirely sure. That's what you'd use to compile the help docs.
'Soludra' on Achaea

Blog: http://jonathan.com/
GitHub: http://github.com/Twisol
[Go to top] top
Posted by Erendir   Germany  (47 posts)  [Biography] bio
Date Fri 17 Sep 2010 10:22 PM (UTC)  [ quote  ]
Message
I knew, i seen here somewhere on the forum a possibility to customize the help!

It's here: http://gammon.com.au/forum/bbshowpost.php?id=8973

The question now is only "how to compile this docgen???"
[Go to top] top
Posted by Erendir   Germany  (47 posts)  [Biography] bio
Date Fri 17 Sep 2010 08:58 PM (UTC)  [ quote  ]
Message
It's just so that in just every topic i open in the help i usually scroll down to the Lua examples, and this is really annoying.
[Go to top] top
Posted by Twisol   USA  (2,230 posts)  [Biography] bio
Date Fri 17 Sep 2010 08:44 PM (UTC)  [ quote  ]
Message
No, the help files are entirely static. The examples are pretty similar in each language though; the difference is usually down to syntax. And some topics don't have Lua examples, if I remember correctly. It's not that big of a deal, in my experience. :)
'Soludra' on Achaea

Blog: http://jonathan.com/
GitHub: http://github.com/Twisol
[Go to top] top
Posted by Erendir   Germany  (47 posts)  [Biography] bio
Date Fri 17 Sep 2010 08:42 PM (UTC)  [ quote  ]
Message
Oh, that's great!
Thank You for such quick response!


Another question (don't want to start other topic yet):
can I get rid of VBscript, JScript etc. examples in the help? I'm interested only in Lua examples.
[Go to top] top
Posted by Twisol   USA  (2,230 posts)  [Biography] bio
Date Fri 17 Sep 2010 08:29 PM (UTC)  [ quote  ]

Amended on Fri 17 Sep 2010 08:30 PM (UTC) by Twisol

Message
There is actually no difference between world.SomeFunction and SomeFunction. Without going into the details, the 'world' table is basically the default context of the script.

What you want is GetPluginVariable("", "var"). Using "" as the plugin ID for GetPluginVariable tells it to check the world instead.

[EDIT]: If you want to make it slightly more obvious, you can do this:
function GetWorldVariable(name)
  return GetPluginVariable("", name)
end

Note(GetWorldVariable("var"))

This doesn't change what happens, it just hides it behind a new function.
'Soludra' on Achaea

Blog: http://jonathan.com/
GitHub: http://github.com/Twisol
[Go to top] top
Posted by Erendir   Germany  (47 posts)  [Biography] bio
Date Fri 17 Sep 2010 08:26 PM (UTC)  [ quote  ]
Message
The question may sound stupid, but i can't figure how to get a world variable from plugin inside?

What i do is:
1. Set variable `var` to `test` in the world properties-window
2. type `/print(GetVariable('var'))` in command input window (`/` is the script prefix)
I get `test` as expected
3. After that, i install some plugin with
<script>
<![CDATA[
Note(world.GetVariable('var'), GetVariable('var'))
]]>
</script>

4. The output i get is `nilnil`, and expected was `testnil` or `testtest`

So, what am i doing wrong?
[Go to top] top

The dates and times for posts above are shown in Universal Co-ordinated Time (UTC).

To show them in your local time you can join the forum, and then set the 'time correction' field in your profile to the number of hours difference between your location and UTC time.

1,812 views.

[Reply to this subject]  Reply to this subject   [New subject]  Start a new subject   [Refresh] Refresh page

Go to topic:           Search the forum

[Go to top] top

[Home]

Written by Nick Gammon - 5K

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( http://www.gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Internet Contents Rating Association (ICRA) - 2K]    [Web site powered by FutureQuest.Net]