-
Notifications
You must be signed in to change notification settings - Fork 7
/
Naudiz's Style Guide.txt
615 lines (423 loc) · 23.2 KB
/
Naudiz's Style Guide.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
Preamble:
The following keywords are used to clarify the importance of each convention: MUST, SHOULD, MAY, SHOULD NOT, MUST NOT.
In the code examples below, the sequence "// ..." (two slashes, one space, three full stops) denotes a line where, in most cases, more code should be written.
However, such code is unnecessary for the purposes of each example.
Comments from the writer that do not necessarily dictate style guidelines are preceded by the sequence "// NAZ: ".
1: Identifiers
1.1: Variables and Constants
Note:
Variables and constants SHOULD be declared with explicit type keywords (float, int, bool, char, string, etc.), unless the type is unknown,
in which case either "let" or "var" is used. These keywords are interchangeable, but the scripter MUST decide on one to use consistently.
Variables MUST be written using camelCase*, while constants MUST use SCREAMING_SNAKE_CASE.
Related identifiers SHOULD share the leading parts of their names for alphabetization purposes.
In cases where variables have short names or are uninitialized, multiple variables MAY be declared on the same line, separated by commas.
They SHOULD be of the same type, so fewer keywords are necessary.
*If necessary, a prefix or suffix MAY be added to a variable in the snake_case style.
DO:
float posX, posY;
const int BOSS_RUMIA = 0;
const int BOSS_CIRNO = 1;
DON'T:
let xPos;
let yPos;
const RUMIA_BOSS = 0, CIRNO_BOSS = 1;
1.1.1: Local Variables
Variables defined within a local scope, such as inside a function or task, MUST use camelCase without any underscores.
EXAMPLE:
func<void> DoSomething()
{
float posX, posY;
// ...
}
1.1.2: Global Variables
Variables defined globally in any script SHOULD be denoted with a leading underscore.
This is similar to the notation used for tasks, but with camelCase instead of PascalCase.
EXAMPLE:
int _objEnemy;
int _objPlayer;
@Initialize
{
// ...
}
1.1.3: Parameters
Function and task parameters SHOULD be denoted with a trailing underscore.
Parameters SHOULD be declared with type keywords, or either "let" or "var" if unknown.
EXAMPLE:
func<void> DoSomethingElse(int foo_, float bar_)
{
// ...
}
1.1.4: Iterators
Iterator variables declared in for-loops, ascent-loops, and descent-loops SHOULD be named lowercase letters of the alphabet starting with "i",
progressing to the next letter for each nested loop. This convention MAY be bypassed if more semantic information is necessary.
Iterator variables declared in for-each-loops SHOULD have single-word names prefixed with "i".
Fun fact: It is possible to add a second iterator to a for-each-loop, which is listed before the first and iterates through the array's indices (starting from 0) instead of its elements.
This variable SHOULD follow the same rules as those declared in for-loops.
EXAMPLE:
for (int i = 0; i < 2; i++) {
ascent (j in 0 .. 3) {
descent (k in 0 .. 4) {
// ...
}
}
}
for each (iObj in arrObj) {
// ...
}
for each ((i, iObj) in arrObj) {
// ...
}
1.1.5: Constants
As mentioned previously, constants MUST use SCREAMING_SNAKE_CASE. All constants SHOULD be defined in a dedicated constant library.
Numeric constants SHOULD be integers instead of float numbers (denoted in decimal literals by appending the character "i" at the end,
but this is not necessary if the constant type is explicitly defined).
EXAMPLE:
const int PLAYER_REIMU = 0;
const int PLAYER_MARISA = 1;
const int PLAYER_SAKUYA = 2;
const int PLAYER_SANAE = 3;
1.2: Functions, Tasks, and Subroutines
Note:
Function, task, and subroutine names all MUST use PascalCase to differentiate them from other identifiers.
The root of the identifier name SHOULD begin with a verb.
// NAZ: The "Is...Exists" structure is Engrish through and through, but I use it for consistency with built-in function names.
EXAMPLE:
func<void> DoSomething()
{
// ...
}
func<int> GetSomething(int foo_)
{
// ...
}
func<void> SetSomething(int foo_, float bar_)
{
// ...
}
func<bool> IsSomethingExists(int foo_)
{
// ...
}
1.2.1: Functions
Functions SHOULD be declared with explicit type keywords in angle brackets, unless the type is unknown or variant.
For brevity, functions SHOULD use the abbreviated "func" keyword alias instead of "function" when a type keyword is specified.
Function names MUST use PascalCase with no underscores.*
Function calls require trailing parentheses, even when there are no arguments.
*Excluding cases where there is a necessary prefix or suffix denoting important information, such as object type.
EXAMPLE:
func<void> DoSomething()
{
// ...
}
func<void> DoSomethingElse(bool foo_, float bar_)
{
DoSomething();
// ...
}
func<void> Obj_DoSomething(int obj_)
{
// ...
}
func<void> DoSomething_Obj_Obj(int obj1_, int obj2_)
{
// ...
}
1.2.2: Tasks
Task names SHOULD use one of the following styles (and consistently): PascalCase with a leading underscore, OR PascalCase with a leading uppercase T.
The same rules about affixes and parentheses that apply to functions apply here.
// NAZ: I like to treat my tasks as private routines, so often times you'll see me create a "public" function that calls task nested inside.
// NAZ: ...though, nowadays the same effect is more cleanly achieved by using inline tasks with the "async" keyword.
EXAMPLE:
task _RenderPlayer(int id_)
{
// ...
}
func<void> RenderPlayer_Reimu()
{
_RenderPlayer(PLAYER_REIMU);
// ...
}
func<void> RenderPlayerHitbox()
{
async
{
// ...
}
}
1.2.3: Subroutines
Subroutines MUST use PascalCase, and SHOULD include a trailing underscore. Parentheses MAY be used.
It is possible to use the at sign (@) in place of the "sub" keyword, but scripters SHOULD NOT do so, to prevent confusion with built-in routines (@Initialize, @MainLoop, @Finalize, etc.).
// NAZ: I don't think I've ever used one of these, lol. I came up with the underscore rule on the fly.
EXAMPLE:
sub DoSomethingDifferent_
{
// ...
}
2: Whitespace
Note:
For the sake of consistency, spaces SHOULD be used instead of tabs in ALL cases.
The default tab is equivalent to 4 spaces; any decent editor should have an option to insert spaces upon pressing the tab key.
2.1: Operators
Expressions and statements consisting of one or more literals and/or identifiers MUST employ one space on both sides of all binary and ternary operators
(=, +, -, *, /, ~/, %, ^, ~, +=, -=, *=, /=, ~/=, %=, ^=, ~=, ==, !=, >, <, >=, <=, &&, ||, &, |, ^^, .., ?, :).
Expressions and statements consisting of an identifier and a unary operator (!, ++, --) MUST NOT employ a space between the operator and operand.
DO:
float someNum = 6 * 9 + 4 / 20 - 6 % 66;
someNum++;
DON'T:
float someNum = 6*9+4/20-6%66;
someNum ++;
// NAZ: I will send you to the Shadow Realm if you don't put spaces in between your operators like in the "DON'T" example. It's entirely unreadable for me.
2.2: Variables and Constants
Variable and constant declaration and assignment statements MUST employ one space between the keyword (let, var, const) and the identifier,
and on both sides of the assignment operator (=) if applicable.*
As stated previously, if identifiers have short names or are uninitialized, their declarations MAY go on the same line, separated by commas and followed by spaces.
*Additional spaces MAY be used to vertically align the operator and right-hand side of each statement in a group of statements. See the example.
EXAMPLE:
const int BGM_TITLE = 0;
const int BGM_1_ROAD = 1;
const int BGM_1_BOSS = 2;
const int BGM_GAMEOVER = 3;
2.3: Functions, Tasks, and Subroutines
Function, task, and subroutine definitions MUST employ one space between the keyword (function, task, or sub) and the identifier,
and NO space between the identifier and the parentheses, differently from flow control statements.
Parameters contained inside the parentheses MUST employ one space between each identifier, i.e. after each comma.
The opening and closing braces of a function, task, async, or subroutine block MUST go on their own lines, and all lines in between them MUST be indented.
There MUST also be an empty line following each closing brace.
The same rules also apply to @Initialize, @MainLoop, @Event, @Finalize, and @Loading.
// Natashi: I don't like placing opening curly braces on newlines. *turns half of your body into pizza dough*
Function, task, and subroutine invocations MUST NOT include a space between the identifier and parentheses, if applicable.
Like parameters, arguments MUST be separated by whitespace, i.e. after each comma.
Function and task arguments MAY span several indented lines for readability purposes.
There SHOULD be an empty space following each multi-line function call, unless it precedes a closing brace or parenthesis.
// NAZ: This is only really applicable if the arguments get unbearably long, though. The example just demonstrates it just because.
EXAMPLE:
@Initialize
{
DoSomething(
true,
1,
1.1,
'e',
"abc"
);
// ...
}
func<void> DoSomething(bool foo_, int bar_, float baz_, char qux_, string quux_)
{
// ...
}
2.4: Flow Control Statements
Flow control statements MUST employ whitespace on both sides of each keyword
(if, else, loop, while, ascent, descent, in, for, each, alternative, case, others, switch, default, local, yield, break, continue),
unless said keyword by itself is a statement (yield, break, continue), in which case it is simply terminated with a semicolon.
For conditionals and loops, the opening curly brace SHOULD go on the same line as the preceding keyword or closing parenthesis, following a space.*
The closing curly brace SHOULD go on its own line, except in the case of "else" and "else if" which SHOULD be written after a space following the closing brace.
Loops and conditional structures SHOULD be followed by an empty line.
For for-loops, each statement ending in a semicolon MUST be followed by a space, i.e. the first and second.
The second and third statements may be omitted, in which case a space SHOULD be used instead.
When statements are combined with commas, there MUST be a space after each of them.
*Conditionals and loops containing a single statement terminated with a semicolon MAY be written without curly braces,
in which case they SHOULD be written on the same line as the rest of the statement, following a space.
Nested conditionals and loops may also be written without curly braces, provided that there is only one semicolon-terminated statement within it.
Alternative cases written this way MAY use additional spaces to align their contents.
EXAMPLE 1 (VERBOSE):
for (int i = 1, j = 2; i <= 10; i++, j--) {
alternative (i)
case (1) {
WriteLog("i is 1!", "j is 2!");
}
case (2) {
WriteLog("i is 2!", "j is 1!");
}
others {
WriteLog("I can't count that high!");
}
if (i >= 3) {
break;
} else {
loop (5) {
yield;
}
}
}
EXAMPLE 2 (CONCISE):
for (int i = 1, j = 2; i <= 10; i++, j--) {
alternative (i)
case (1) WriteLog("i is 1!", "j is 2!");
case (2) WriteLog("i is 2!", "j is 1!");
others WriteLog("I can't count that high!");
if (i >= 3) break;
else loop (5) yield;
}
// NAZ: With "wait" being built-in there's no use case for "loop (n) yield;".
// NAZ: I simply wanted to demonstrate nested structures and how they can be shortened.
2.5: Arrays
Arrays elements MUST be separated by whitespace, i.e. after each comma.
Multidimensional or otherwise verbose arrays MAY be written across several indented lines.
The initial opening square brace MUST go on the same line as the operator that precedes it.
The new lines and indenting SHOULD be consistent throughout each dimension of the array.
There SHOULD be an empty space following each multi-line array, unless it precedes a closing brace or parenthesis.
For performance reasons, arrays SHOULD be indexed as infrequently as possible.
If only one element is needed, storing it in a variable is recommended.
EXAMPLE:
int[] arrSmall = [1, 2, 3];
int[][] arrBig = [
[1, 2, 3],
[4, 5, 6, 7],
[8, 9, 10, 11, 12]
];
int[][][] arrBigger = [
[
[1, 2, 3],
[4, 5, 6, 7],
], [
[8, 9, 10, 11, 12],
[13, 14, 15, 16, 17, 18],
[19, 20, 21, 22, 23, 24, 25],
]
];
int numSmall = arrSmall[2];
int numBig = arrBig[2][4];
int numBigger = arrBigger[1][2][6];
3: Organization
3.1: Script Structure
All scripts SHOULD have their sections organized in the following order:
1. Headers (#TouhouDanmakufu, #ScriptVersion*, #Title, #Text, #System, #Background, #BGM)
2. #include directives
3. Global variables
4. Predefined routines (@Initialize, @Event, @MainLoop, @Finalize, @Loading)
5. Script-specific routines
*The #ScriptVersion header can only take one possible argument (3), and SHOULD be omitted altogether.
EXAMPLE:
#TouhouDanmakufu[Stage]
#Title["Example Stage"]
#Text["An example of a stage script."]
#System["script/script_system.dnh"]
#include "script/include_stg.dnh"
int _idScript;
@Initialize
{
_idScript = GetOwnScriptID();
_Main();
}
@MainLoop
{
yield;
}
@Finalize
{
WriteLog("Game over!");
}
task _Main()
{
while (GetPlayerState() != STATE_END) yield;
CloseScript(_idScript);
}
3.2: Included Files
As a preface, what the #include directive does is tell the engine to copy the contents of a given text file and paste them into the script, replacing the #include directive.
If a file has already been included in the script, it will be skipped.
To reduce the amount of boilerplate in each script file, the scripter SHOULD create files with the express purpose of including several other files, ideally in a hierarchical manner.
DO:
// In include_main.dnh
#include "./lib_main.dnh"
#include "./lib_const.dnh"
#include "./lib_math.dnh"
#include "./lib_render.dnh"
#include "./lib_event.dnh"
// In include_stg.dnh
#include "./include_main.dnh"
#include "./lib_stg.dnh"
#include "./lib_move.dnh"
#include "./lib_shot.dnh"
#include "./lib_enemy.dnh"
// In include_boss.dnh
#include "./include_stg.dnh"
#include "./lib_boss.dnh"
#include "./lib_anim.dnh"
#include "./lib_spell.dnh"
// In the main script
#TouhouDanmakufu[Single]
// ...
#include "script/include_boss.dnh"
@Initialize
{
// ...
}
DON'T:
// In the main script
#TouhouDanmakufu[Single]
// ...
#include "./lib_main.dnh"
#include "./lib_const.dnh"
#include "./lib_math.dnh"
#include "./lib_render.dnh"
#include "./lib_event.dnh"
#include "./lib_stg.dnh"
#include "./lib_move.dnh"
#include "./lib_shot.dnh"
#include "./lib_enemy.dnh"
#include "./lib_boss.dnh"
#include "./lib_anim.dnh"
#include "./lib_spell.dnh"
@Initialize
{
// ...
}
// NAZ: These file paths assume that the script as well as all of the library files are located in the base script directory.
// NAZ: Ideally, you should have a dedicated lib folder, possibly with subfolders corresponding to the libraries contained in each "include" file.
3.3: Script Routines
Scripts (particularly those in which danmaku is created) SHOULD call a task named _Main (or TMain, depending on your chosen style) from @Initialize.
This task SHOULD be the ultimate source of all other script-specific routine invocations.
The scripter SHOULD make use of nesting for a few reasons:
1. To ensure that variables are limited to their intended scopes.
2. To prevent the need to pass variables around unnecessarily via arguments.
EXAMPLE 1 (NON-NESTED):
task _Main()
{
float dir;
loop {
dir = rand(0, 360);
_Fire(dir);
wait(60);
}
}
task _Fire(float dir_)
{
float speed = 1;
loop (5) {
Shoot(speed, dir_);
speed++;
wait(2);
}
}
func<void> Shoot(float speed_, float dir_)
{
int obj = CreateShotA1(someX, someY, speed_, dir_, someID, 15);
ObjShot_SetDeleteFrame(obj, 180);
}
EXAMPLE 2 (NESTED):
task _Main()
{
float dir;
loop {
dir = rand(0, 360);
_Fire();
wait(60);
}
task _Fire()
{
float speed = 1;
loop (5) {
Shoot_;
speed++;
wait(2);
}
sub Shoot_
{
int obj = CreateShotA1(someX, someY, speed, dir, someID, 15);
ObjShot_SetDeleteFrame(obj, 180);
}
}
}
// NAZ: These examples are intentionally bare-bones and only exist for the purposes of demonstrating how nesting can simplify task and function signatures and establish a sense of hierarchy.