 |
darmir
Sorcerer
Joined: 10 Oct 2000
Posts: 706
Location: USA
|
 Posted: Thu Nov 11, 2010 4:36 pm
NOTES
|
Zugg,
I see that you can add notes to classes, triggers, aliases, etc... Is there a command that will let you do this?
Would be nice to add a note from the command line
Example:
| Code: |
| Syntax: #NOTE classname|triggername|aliasname note |
|
|
_________________
Run as hard as a wild beast if you will, but you won't get any reward greater than that destined for you.
Source: (Egyptian) |
 |
|
|
Zugg
MASTER
Joined: 25 Sep 2000
Posts: 23379
Location: Colorado, USA
|
Posted: Thu Nov 11, 2010 5:33 pm
|
Nope, sorry, just via the GUI.
|
|
|
|
|
darmir
Sorcerer
Joined: 10 Oct 2000
Posts: 706
Location: USA
|
Posted: Thu Nov 11, 2010 5:51 pm
|
Is that a Nope for, no command or for can't add a command in the future?
|
|
_________________
Run as hard as a wild beast if you will, but you won't get any reward greater than that destined for you.
Source: (Egyptian) |
|
|
|
Tech
GURU
Joined: 18 Oct 2000
Posts: 2733
Location: Atlanta, USA
|
Posted: Thu Nov 11, 2010 7:10 pm
|
I'm guessing he meant just the first, but I'm having trouble imagining how a command would be useful. Any notes that I've associated with trigger's aliases etc are usually to help me keep track of design before they are done, or remind me exactly how they work when they are done.
If I'm adding a note to something it's a permanent note, and usually no less work to just do it via the GUI. Perhaps the only plausible scenario I can imagine is if your programmatically creating triggers, say for a quest or something, you might want a note. But it's such a niche scenario I hardly think it's worth another command. |
|
_________________
Asati di tempari! |
|
|
|
darmir
Sorcerer
Joined: 10 Oct 2000
Posts: 706
Location: USA
|
Posted: Thu Nov 11, 2010 7:51 pm
|
| Tech wrote: |
| Perhaps the only plausible scenario I can imagine is if your programmatically creating triggers, say for a quest or something, you might want a note. But it's such a niche scenario I hardly think it's worth another command. |
That is exactly why I think it would be nice to have. I was thinking of my package(s) where I create a class and variables the the onload event to remind me why there are there and for people who install the package they can find out why this class with variables showed up in their session window. |
|
_________________
Run as hard as a wild beast if you will, but you won't get any reward greater than that destined for you.
Source: (Egyptian) |
|
|
|
Tech
GURU
Joined: 18 Oct 2000
Posts: 2733
Location: Atlanta, USA
|
Posted: Thu Nov 11, 2010 8:38 pm
|
Why wouldn't that simply go in your package documentation?
|
|
_________________
Asati di tempari! |
|
|
|
darmir
Sorcerer
Joined: 10 Oct 2000
Posts: 706
Location: USA
|
Posted: Thu Nov 11, 2010 10:15 pm
|
| Tech wrote: |
| Why wouldn't that simply go in your package documentation? |
Here is my example of the event, which I create the class and variables during setup.
| Code: |
<event event="onLoad" priority="60" id="6">
<value><![CDATA[#local $curwin
$curwin = %window
#if ( !@SpeechTypeGV/setup) {
#MODULE %window
#CLASS SpeechTypeGV
#NEWVAR SpeechTypeGV/speech 1
#NEWVAR SpeechTypeGV/st_intensity 3
#NEWVAR SpeechTypeGV/setup 1
#CLASS 0
#MODULE 0
#PRINT {<color yellow>#################################</color>}
#PRINT Speech Types Package has been installed for $curwin
SpeechHelp
#PRINT {<color yellow>#################################</color>}
#PRINT {}
}]]></value>
</event>
|
I was thinking If I can make a note so the user sees it they know why it was created.
Where would you suggest to put that in the package documentation? |
|
_________________
Run as hard as a wild beast if you will, but you won't get any reward greater than that destined for you.
Source: (Egyptian) |
|
|
|
MattLofton
GURU
Joined: 23 Dec 2000
Posts: 4834
Location: USA
|
Posted: Thu Nov 11, 2010 11:48 pm
|
With the Package Editor open, click on the Edit menu and select Package Properties. This big textbox is where you type in anything you want the user to see when looking at your package in the Package Library.
If that's too technical or whatever for your taste, just write a note in the setting code itself using comments. 9 times out of 10 the user's just going to go "Hey, what's this?" and then click on it to see what's there. |
|
_________________
EDIT: I didn't like my old signature |
|
|
|
darmir
Sorcerer
Joined: 10 Oct 2000
Posts: 706
Location: USA
|
Posted: Fri Nov 12, 2010 3:06 am
|
| MattLofton wrote: |
With the Package Editor open, click on the Edit menu and select Package Properties. This big textbox is where you type in anything you want the user to see when looking at your package in the Package Library.
If that's too technical or whatever for your taste, just write a note in the setting code itself using comments. 9 times out of 10 the user's just going to go "Hey, what's this?" and then click on it to see what's there. |
I guess you just don't get it.  |
|
_________________
Run as hard as a wild beast if you will, but you won't get any reward greater than that destined for you.
Source: (Egyptian) |
|
|
|
Zugg
MASTER
Joined: 25 Sep 2000
Posts: 23379
Location: Colorado, USA
|
Posted: Fri Nov 12, 2010 5:55 pm
|
Actually, I think there *is* a way to do this. See, CMUD really can do everything! I just forget everything that it can do sometimes.
CMUD has a COM-based API for it's settings. You can grab the COM object for your alias and then use the Comment property to set the "notes". Like this:
| Code: |
// first, define an alias
#ALIAS test {hello world}
// now, get a reference to the Alias object
a = %session.GetAlias("test","")
// now set the Comment property
a.comment = "This is a test" |
Open the Package Editor and you'll see the comment for the "test" alias has been set to "This is a test".
There you go!
COM stuff documented here: http://www.zuggsoft.com/page.php?file=zmud/comserve.htm |
|
|
|
|
darmir
Sorcerer
Joined: 10 Oct 2000
Posts: 706
Location: USA
|
Posted: Fri Nov 12, 2010 7:51 pm
|
Thanks Zugg worked like a charm!
|
|
_________________
Run as hard as a wild beast if you will, but you won't get any reward greater than that destined for you.
Source: (Egyptian) |
|
|
|
|
|
|
