Archived
1
0
Fork 0
This repository has been archived on 2025-03-02. You can view files and clone it, but cannot push or open issues or pull requests.
uranos/README.md
2021-01-03 19:46:24 +01:00

1.5 KiB
Raw Blame History

Uranos

Milestones

  • Players can see entities
  • Players can see other players
  • Players can send and receive chat messages
  • Players can see Titles
  • Weather and time
  • Players can hear sounds
  • Players can see particles
  • Players can have items (with metadata) in their inventory
  • Inventories
  • World modifications are sent to players
  • Crafting
  • PlayerInteract events are emitted when blocks are clicked
  • Command framework + permissions
  • Commands can be sent from the console
  • Players can be teleported between worlds
  • Entity AI framework
  • Scoreboards + Teams

Conventions

KDoc

  1. If the name of the target is already sufficient for understanding what it does or what it's value represents, you should not add a comment. If you want to provide additional information however, you should start the comment with a short description nevertheless.
  2. The name of the return type, property type or type of the enclosing class should not be wrapped in square brackets.
  3. If a comment only consists of the @returns block tag, the latter should be replaced with a sentence starting with Returns .

Code

  1. If a member function of a class creates an instance of another class which represents the same value, the functions name should be as<name of the other class>. If the new instance does not exactly represent the value of the original instance (for example because it is rounded), the name should be to<name of the other class>.