Staredit Network > Forums > SC1 UMS Theory and Ideas > Topic: Using Comments in Mapmaking
Using Comments in Mapmaking
May 6 2008, 5:01 am
By: SOLAR
Pages: 1 2 3 >
 

May 6 2008, 5:01 am SOLAR Post #1



I've been told that some mapmakers don't use comments. The reason being that they can cause trouble with scmdraft apparently, something I havn't come across, and also that they waste strings, which usually isn't a problem. I personally would go nuts without comments. I don't understand why people would want to make a complex map without them. I heard that Lesk and Tuxlar don't use comments... Sounds strange to me. I've used them for every serious production beyond Solarball. What do you all think about them?



None.

May 6 2008, 5:08 am A_of-s_t Post #2

aka idmontie

I make maps without comments. I just use well commented javascript to output the text for triggers and I put it into SCMD using the trigger editor that it originally came with. Hence, I do not use comments for my triggers.

Comments also take up strings, which are very valuable since you can only use 1024 strings while still create a safe map.



Personal GitHub
Starcraft GitHub Organization - Feel free to request member status!
TwitchTV

May 6 2008, 5:53 am Demented Shaman Post #3



Quote from SOLAR
I've been told that some mapmakers don't use comments. The reason being that they can cause trouble with scmdraft apparently, something I havn't come across, and also that they waste strings, which usually isn't a problem. I personally would go nuts without comments. I don't understand why people would want to make a complex map without them. I heard that Lesk and Tuxlar don't use comments... Sounds strange to me. I've used them for every serious production beyond Solarball. What do you all think about them?
Whoever told you I don't comment is wrong. I comment almost all of the time.

One of the reasons for not commenting is that it allows you to see the actions/conditions. That's one of the reasons I have agreed with at times when I did not comment. However, currently in my own maps I don't find it necessary to be able to see what the actions/conditions are.

My comments mainly consist of a never comment header followed by a bunch of blank comments, if there are several triggers related to doing one thing. However, if there are unique triggers that do something specific that would easily get lost in a bunch of blank comments, I just comment that with a one word description.

The main reason I comment is because it saves space, and makes it easier to look at in classic trigedit. Being able to see the individual actions/conditions in each trigger without opening the trigger is only marginally useful. I find the organizational benefits of commenting to be more useful.



None.

May 6 2008, 6:13 am Rantent Post #4



I comment them with names when I'm working on them, and then delete the text (Blank comment) when the system works fully. Before I would simply comment everything, but then it would be rather hard to decipher what needed to be worked on, and what was finished. (I tend to have big gaps in map making, where I set something aside and forget about it.)

In short Comments rock. (Although I still wish there were folders in the trigger editor.)



None.

May 6 2008, 6:17 am Demented Shaman Post #5



Arguing whether to comment or not is like arguing which side of your toast to butter or which end of the egg to crack.



None.

May 6 2008, 6:37 pm Falkoner Post #6



I rarely comment, but some people are comment-whores and have a comment on every single trigger, which IMO makes them more annoying to look at, since you cannot see the actions without going into the trigger. Comments, if used at all, should only be used as headers.

What you can do is use something like notepad++ in order to have comments without taking up strings.



None.

May 6 2008, 7:00 pm Demented Shaman Post #7



Quote from Falkoner
I rarely comment, but some people are comment-whores and have a comment on every single trigger, which IMO makes them more annoying to look at, since you cannot see the actions without going into the trigger. Comments, if used at all, should only be used as headers.

What you can do is use something like notepad++ in order to have comments without taking up strings.
Well I think one either comments everything or comments nothing. Commenting only sometimes seems like you aren't taking advantage of the benefits of commenting or taking advantage of not commenting at all.



None.

May 6 2008, 7:01 pm Vrael Post #8



Currently I'm using comments in a map to keep track of the possibilities. There are 4 players, and they can enter each others battles. To keep track of this, I need a trigger for each possibility. example: p1 enters p2 battle, p1 enter p3, p4 enter p1, ect. Without comments I'd probably go nuts keeping track of them. However, On my other systems I just use comments until the systems done, then delete them. At the end of my map production process I may add a blank comment to everything to discourage people from editing the map. Of course, that won't stop everyone, but it'll keep most away.

However, on the 2 popular RP's I made, I didn't use comments at all, except for hyper triggers and maybe 3 other timer triggers. That was because there was only a few hundred triggers and I could easily remember them.



None.

May 6 2008, 7:02 pm Brontobyte Post #9



Comments allow the user (reader) of the triggers to see/find what they are looking for easier and faster then looking through a bunch of triggers and finding the right condition and action. Although some map makers are extremely poor at commenting their triggers because they say things that are way too general. Me on the other hand. I do something like devilesk does. I have a never conditioned trigger with just a comment. In the comment I have an enter then the general comment on what the next few triggers are and then I hit enter again and then bam! its done. I find this useful because its easy to just highlight a big comment and find the triggers under different players and change them if needed, granted that they are under different players slots. I have made a few maps and so far I have never come close to 1024 strings. I have been upwards of around 700 for some but never too much higher then that. The gains out weigh the risks. You can always remove the comments with a map compressor, but it would be too difficult to go through ones map and not know what your looking at. :D



None.

May 6 2008, 7:06 pm Demented Shaman Post #10



Whether one comments or not is rather trivial. It doesn't really have anything to do with whether one makes a good map or not.



None.

May 6 2008, 7:28 pm Twitch Post #11



I usually never comment because it just makes me confused.



None.

May 6 2008, 8:11 pm MillenniumArmy Post #12



It depends on the map im working on.

For Mini-Game Party, i use blank comments. The only real comments I have are on the very first trigger for each set of mini-games. It's a label to indicate that the proceeding blank comments will be dealing with this mini-game. Blank comments don't use strings at all



None.

May 6 2008, 8:27 pm LoveLess Post #13

Let me show you how to hump without making love.

Quote from SOLAR
I've been told that some mapmakers don't use comments. The reason being that they can cause trouble with scmdraft apparently, something I havn't come across, and also that they waste strings, which usually isn't a problem. I personally would go nuts without comments. I don't understand why people would want to make a complex map without them. I heard that Lesk and Tuxlar don't use comments... Sounds strange to me. I've used them for every serious production beyond Solarball. What do you all think about them?
I trigger with text, so comments are pointless. I believe that goes for Tuxlar as well, we do use comments, just in a text program that we copy over to draft's text editor.



None.

May 6 2008, 10:04 pm Falkoner Post #14



I see no reason to use comments until you get over 1000 (unique)triggers, up until then I see no reason to, because as long as you are working with the map on a relatively regular basis, you usually can remember where things are, or what things do.



None.

May 6 2008, 11:34 pm Wing-of-no-Wing Post #15



For my own projects, I find the triggers themselves to be far clearer than comments could ever be. If I'm editing someone else's work, and there are many triggers, it helps to have section headings, but not comments on the individual triggers. The only triggers that I do comment regularly are the hyper triggers (though occasionally I'll put non-informative comments with humor content), and that's just to make them smaller for anyone who might be scrolling through them in an old-style editor that doesn't collapse long triggers.

Renaming the unused units that you use for death counts is many times more helpful than commenting your triggers.



None.

May 8 2008, 8:01 pm Alkali Post #16



Is this thread made because I was complaining about how I didn't use comments cause a lot of ppl on SEN said they don't, and then I couldn't find anything...

Glad to know I'm responsible.


But yes, ever since I about shot myself spending 30 minutes going through near-2000 triggers looking for one, I am going to use comments.

H8 @ non-commenters



None.

May 8 2008, 8:21 pm Twitch Post #17



Nah its not because me and solar went through a conversation about them and how they are annoying.No comments are better anyways :P.

Post has been edited 1 time(s), last time on May 9 2008, 2:21 am by Twitch.



None.

May 8 2008, 9:03 pm O)FaRTy1billion[MM] Post #18

👻 👾 👽 💪

Psh. I don't even rename my locations. :P
Eh. I find it rather useless and a waste of time... I can just read the trigger to see what it does.
I have locations planned out before I place them, so I put them in (what I see to be) a logical order.
I don't use nearly enough switches to even bother naming those.
For deaths I just start at the unused ones and go in a consecutive order.
If my map starts getting far to elaborate for me to remember every little detail, I just take a few notes.. and usually they are rather useless anyway.



TinyMap2 - Latest in map compression! ( 7/09/14 - New build! )
EUD Action Enabler - Lightweight EUD/EPD support! (ChaosLauncher/MPQDraft support!)
EUDDB - topic - Help out by adding your EUDs! Or Submit reference files in the References tab!
MapSketch - New image->map generator!
EUDTrig - topic - Quickly and easily convert offsets to EUDs! (extended players supported)
SC2 Map Texture Mask Importer/Exporter - Edit texture placement in an image editor!
\:farty\: This page has been viewed [img]http://farty1billion.dyndns.org/Clicky.php?img.gif[/img] times!

May 8 2008, 9:40 pm Conspiracy Post #19



You should really only comment conservatilvly, although I have never went of the string limit, that is because I have used them rarely, like labling a system or as Falkoner said, a Header. But never use a Never comment, because that is just a waste of space.

Also, I have a form of OCD called Map OCD (Self diagnosed!). It has to be organized, or it dies >:D.



None.

May 9 2008, 1:45 am payne Post #20

:payne:

Quote from Falkoner
I rarely comment, but some people are comment-whores and have a comment on every single trigger[...]
Lol, that's exactly me :P



None.

Options
Pages: 1 2 3 >
  Back to forum
Please log in to reply to this topic or to report it.
Members in this topic: None.
[06:51 pm]
Vrael -- It is, and I could definitely use a company with a commitment to flexibility, quality, and customer satisfaction to provide effective solutions to dampness and humidity in my urban environment.
[06:50 pm]
NudeRaider -- Vrael
Vrael shouted: Idk, I was looking more for a dehumidifer company which maybe stands out as a beacon of relief amidst damp and unpredictable climates of bustling metropolises. Not sure Amazon qualifies
sounds like moisture control is often a pressing concern in your city
[06:50 pm]
Vrael -- Maybe here on the StarEdit Network I could look through the Forums for some Introductions to people who care about the Topics of Dehumidifiers and Carpet Cleaning?
[06:49 pm]
Vrael -- Perhaps even here I on the StarEdit Network I could look for some Introductions.
[06:48 pm]
Vrael -- On this Topic, I could definitely use some Introductions.
[06:48 pm]
Vrael -- Perhaps that utilizes cutting-edge technology and eco-friendly cleaning products?
[06:47 pm]
Vrael -- Do you know anyone with a deep understanding of the unique characteristics of your carpets, ensuring they receive the specialized care they deserve?
[06:45 pm]
NudeRaider -- Vrael
Vrael shouted: I've also recently becoming interested in Carpet Cleaning, but I'd like to find someone with a reputation for unparalleled quality and attention to detail.
beats me, but I'd make sure to pick the epitome of excellence and nothing less.
[06:41 pm]
Vrael -- It seems like I may need Introductions to multiple companies for the Topics that I care deeply about, even as early as Today, 6:03 am.
[06:38 pm]
Vrael -- I need a go-to solution and someone who understands that Carpets are more than just decorative elements in my home.
Please log in to shout.


Members Online: Roy