Lou Montana/Sandbox – User

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Reverted edits by R3vo (talk) to last revision by Lou Montana)
Tag: Rollback
m (Readd R3vo's additions)
Line 1: Line 1:
__NOTOC__
[[Category: Sandbox]]
[[Category: Sandbox]]
{{Informative | Future [[Code Best Practices]] page}}
{{Informative | Future [[Code Best Practices]] page}}
{{Important | this is at the moment '''only a list of topics''' and absolutely not the final render. Almost each list entry will result in a chapter.}}
----
----
[[:Category: Scripting Topics]]
[[:Category: Scripting Topics]]
== Best practices ==
== Best practices ==
Line 19: Line 25:
=== Variables ===
=== Variables ===


* Prefix your public variables with your tag
* Prefix your public variables and [[setVariable]] with your tag
* PRIVATE (or params) your variables
* PRIVATE (or params) your variables
* Use #define SOME_CONST for constant values instead of variables


=== Code location ===
=== Code location ===

Revision as of 19:27, 5 September 2019

this is at the moment only a list of topics and absolutely not the final render. Almost each list entry will result in a chapter.




Category: Scripting Topics

Best practices

Make it readable

See Make it readable for the short version!
    • Var names
    • Format, indentation, no one-line, spacing, line returns
    • Be consistent (space/tab indentation, (camel)casing, K&R style / Allman style indenting)

Make reusable functions

  • Don't duplicate, make functions

Variables

  • Prefix your public variables and setVariable with your tag
  • PRIVATE (or params) your variables
  • Use #define SOME_CONST for constant values instead of variables

Code location

  • Nothing in init box but local commands for this specific unit - all the init boxes are run client-side on client connection
  • 0 = myCommand is "useful" only for editor fields that for no apparent reason refuse commands returning a value.


Final words

  • Don't steal code and pretend it's yours — be a decent human being.
  • Don't try to obfuscate your code: it's considered rude, especially since you learnt from others.
  • Have fun!