#While true game walkthrough how to
#While true game walkthrough code

This is necessary in Python, but Lua doesn't need anything special to indicate multiline expressions.įor long conditions in if statements, put the condition in its own indented section and place the then on its own line to separate the condition from the body of the if block. Don't put extra parentheses around the whole expression.If you still can't, add a new level of indentation for the parts of the statement inside the open parentheses much like you would with nested tables. If you have to need to add newlines within a parenthesized subexpression, reconsider if you can't use temporary variables.This makes it clearer at a glance that this is a continuation of the previous line. Place the operator at the beginning of the new line.If you have parenthesized subexpressions, put each subexpression on a newline. If you're adding up lots of terms, place each term on its own line. Local MyEnum = )įor long expressions try and add newlines between logical subunits. It defines class members, instance members, and metamethods in the same table and highlights Lua's strengths well.įirst up, we create a regular, empty table: The most popular pattern for classes in Lua is sometimes referred to as the One True Pattern. Metatables are an incredibly powerful Lua feature that can be used to overload operators, implement prototypical inheritance, and tinker with limited object lifecycle.Īt Roblox, we limit use of metatables to a couple cases: Defining the path to FooBar separately makes it faster to write and for others to read! local FooBar = MyProject. A block for modules imported from the same project. These are simple so we don't need to break them down. and then access its members through that API. A block for definitions derived from packages. Baz is a library we depend on in our project, so we require its API directly. Use a relative path to make sure your project works in multiple locations! local MyProject = script. Library internals should require their public and private modules directly, eg.

#While true game walkthrough code

This allows libraries to have stable interfaces even when internal details may change, and can be used both for sharing code as well as for organizing one's own code. Libraries will typically provide a structured public API composed from internal modules.

Libraries are projects which define an API for external consumers to use, typically by providing a top-level table which requires other modules. * If multiple require statements share a common path, prefer to move those to a separate block. * Blocks should be sorted alphabetically, first by the name of the subfolder which groups the block, and then by module name.

A block for modules imported from the same project, which may be broken down recursively by subfolder.

A block for definitions derived from packages, which may be broken down recursively by subfolder.

Require blocks should mimic the project's internal structure and consist of these things (if present) in order: In order to maintain readability, require statements can be grouped into blocks.

Requires should be sorted alphabetically by module name.

All require calls must be at the top of a file, making dependencies static.

Services used by the file, using GetService.

Don't attach the file name, author, or date - these are things that our version control system can tell us.

An optional block comment talking about why this file exists.

Be consistent with idiomatic Lua when appropriate.įiles should consist of these things (if present) in order:.

Metatables are a good example of a powerful feature that should be used with care.

#While true game walkthrough how to

Then no one knows why it broke or how to fix it. Magical code is really nice to use, until something goes wrong.Avoid magic, such as surprising or dangerous Lua features:.Clean diffs make it easier to get your code reviewed. It's much easier to read a diff that doesn't involve moving things between lines. All else being equal, consider what the diffs might look like.Many people will need to read it, from the reviewers, to any one else that touches the code, to you when you come back to it in six months. Optimize code for reading, not writing.There's no one right answer to how to format code, but consistency is important, so we agree to accept this one, somewhat arbitrary standard so we can spend more time writing code and less time arguing about formatting details in the review.The purpose of a style guide is to avoid arguments.Although Lua is a significantly different language, the guide's principles still hold. This guide is designed after Google's C++ Style Guide. This style guide aims to unify as much Lua code at Roblox as possible under the same style and conventions.