Office architecture

Office Architecture (the name is to be changed in future) is the game about micro- and macro- office management. Hire, fire and force to work employees under the pressure of your boss tasks.

Game design

Design document of the game can be found here[RUS]

Code conventions

Animators

Some animators, such as UI animators require their updateMode set to AnimatorUpdateMode.UnscaledTime but some animators such as employee animators require their updateMode set to AnimatorUpdateMode.Normal as there's ability to speed up/slow down time in game so UI animators shouldn't depend on Time.TimeScale.

Automatization of process of assigning correct updateModes is addressed by Utils.AnimatorTimeScaleSetterTool. This script adds menu item Tools -> AnimatorTimeScaleSetter to set proper updateModes to animators in both scene hierarchy and prefabs folder.

Separation into two categories is made according to the following assumptions:

• In scene hierarchy: All the UI animators contain Canvas in one of their parent GameObjects.
• In prefabs folder: All the UI animators are attached to prefabs found in Assets\Prefabs\UI directory and all its subdirectories.

One can easily override these rules by attaching Utils.IgnoreAnimatorTimeScaleSetter script to the target GameObject.

Namespaces

It's very desirable for classes to belong to some namespace. But for now Unity doesn't support MonoBehaviours that have their name different from the script's name. So the [AddComponentMenu("...")] attribute is used to override the component's name when script is attached to GameObject.

Label in attribute must have two parts:

• Namespace separated with / that started with Scripts
• Component name that contains namespace with class name

namespace Level.Boss
{
    // Example attribute
    [AddComponentMenu("Scripts/Level/Boss/Level.Boss.Model")]
    public class Model { ... }
}

When the class with name identical to the namespace's one is needed, for example:

namespace Level
{
    [AddComponentMenu("Scripts/Level.Level")]
    public class Level { ... }
}

it should be renamed to ...Impl:

namespace Level
{
    [AddComponentMenu("Scripts/Level.Level")]
    public class LevelImpl { ... }
}

Note: Impl is omitted in AddComponentMenu attribute. For comfortable executing this rules This Unity Package and This Visual Studio Extension can be used. Both package and extension gives opportunity to create unity scripts with proper naming rules in one click.

Formatting

Project uses two formatters: .NET format and CSharpier.

• Rules for .NET format described in .editorconfig file.
• Rules for CSharpier described in .csharpierrc.json file.

.Net format it's a builtin formatter for .NET and can be found here.
CSharpier it's a tool that can be found here and installed for any popular IDE.

OdinInspector

Odin Inspector used in project for comfortable debugging and proper visualization complex data structures in Inspector.

When some variables are private in MonoBehaviour script, but will helpful to see in inspector, Odin provides [ReadOnly] attribute:

using Sirenix.OdinInspector;
...
public class Model : MonoBehaviour
{
    [ReadOnly]
    [SerializeField]
    private float privateVariable;
    ...
}
...

When you need to test some method, [Button] attribute used to create button in inspector to invoke that method for testing.

using Sirenix.OdinInspector;
...
public class Model : MonoBehaviour
{
    [Button]
    private void SomeAction() { ... }
    ...
}
...

Pickle settings

On first project startup Pickle will propose to create PickleSettings.asset. Don't create it as it's already present at /Assets/Plugins folder.

License

GNU General Public License