Page 1 of 1

Multiline map comments

Posted: Sun Mar 17, 2019 10:51 pm
by Zehra
While we do have shell style single line comments, multi-line comments would be very useful for map makers.
It would make several things much easier, especially when working with large scale maps and the temporary commenting out of objects is needed.

-Zehra

Re: Multiline map comments

Posted: Mon Mar 18, 2019 1:33 am
by macsforme
And what is your proposed syntax for this feature?

Re: Multiline map comments

Posted: Mon Mar 18, 2019 6:33 am
by allejo
If you use an editor with syntax highlighting, you can highlight a block of text and use your editor's comment shortcut. Real haxors use keyboard shortcuts.

Re: Multiline map comments

Posted: Mon Mar 18, 2019 10:36 pm
by Zehra
macsforme wrote:
Mon Mar 18, 2019 1:33 am
And what is your proposed syntax for this feature?
C style comments.
allejo wrote:
Mon Mar 18, 2019 6:33 am
If you use an editor with syntax highlighting, you can highlight a block of text and use your editor's comment shortcut. Real haxors use keyboard shortcuts.
While it may be easy for us, I'm certain the majority of players have never used source code editors before.(Much less code.)

-Zehra

Re: Multiline map comments

Posted: Tue Mar 19, 2019 12:14 am
by tainn
For what's worth, I do encounter cases where I have to (temporarily) remove a section of objects, though I simply use two separate text files to achieve that. Maybe multi-line comments might make that more elegant, though there are simple workarounds now already.

I would probably still use the two text files at the end of the day, since they also help out with other, potentially more frequent issues. One of them is find and replace, where I was to mass-change the values of some objects, but not all of them. Since my editor only allows file-wide changes, not selection-wide ones, I cut the part I want changed to the secondary file, modify it, and cut it back to the primary. This is an example of a frequent use.

Re: Multiline map comments

Posted: Tue Mar 19, 2019 7:21 pm
by Zehra
tainn wrote:
Tue Mar 19, 2019 12:14 am
For what's worth, I do encounter cases where I have to (temporarily) remove a section of objects, though I simply use two separate text files to achieve that. Maybe multi-line comments might make that more elegant, though there are simple workarounds now already.
For most other games, this is a general feature which does not even need to be mentioned as it is already expected.
Multi-line comments should be supported, as it would be the proper way to do things.
tainn wrote:
Tue Mar 19, 2019 12:14 am
I would probably still use the two text files at the end of the day, since they also help out with other, potentially more frequent issues.
In the end it comes down to personal preference, but all of us have found workarounds for the current lack of multi-line comments.
tainn wrote:
Tue Mar 19, 2019 12:14 am
One of them is find and replace, where I was to mass-change the values of some objects, but not all of them. Since my editor only allows file-wide changes, not selection-wide ones, I cut the part I want changed to the secondary file, modify it, and cut it back to the primary. This is an example of a frequent use.
It is reasonable to expect a source code editor or even a text editor to have 'find and replace', the same as it is reasonable to ask for the bzw syntax to support multi-line comments.
The part of the editor not supporting section-wide changes is related to the editor and not bzw syntax.
Secondary files for editing is something even I've done, and while it can be an example of frequent usage, it does not mean efficient usage.

-Zehra

Re: Multiline map comments

Posted: Wed Mar 20, 2019 1:14 am
by blast
Zehra wrote:
Tue Mar 19, 2019 7:21 pm
tainn wrote:
Tue Mar 19, 2019 12:14 am
For what's worth, I do encounter cases where I have to (temporarily) remove a section of objects, though I simply use two separate text files to achieve that. Maybe multi-line comments might make that more elegant, though there are simple workarounds now already.
For most other games, this is a general feature which does not even need to be mentioned as it is already expected.
Multi-line comments should be supported, as it would be the proper way to do things.
What other games have a plain-text map format and multi-line comments? We could see how they handle it. Looks like Quake 3 has a plain-text map format used by editors, but seems to only have single line comments.

Re: Multiline map comments

Posted: Thu Mar 21, 2019 12:14 am
by Zehra
blast wrote:
Wed Mar 20, 2019 1:14 am
What other games have a plain-text map format and multi-line comments? We could see how they handle it. Looks like Quake 3 has a plain-text map format used by editors, but seems to only have single line comments.
My bad, I was mistaken on the subject.
My thoughts were that it may be a widespread feature [within games that support map file comments], but this does not appear to be the case.

-Zehra