redbluegames / unity-lite-fsm Goto Github PK

StateReflector is untested. It needs tests to verify:

• GetStates() creates a state for every entry of T.
• GetStates() finds the correct methods regardless of their accessibility
• GetStates() finds the correct methods when alternate syntax is used

Methods and classes need comments explaining how to use them.

The project needs a simple README. It should be short and sweet with the following topics:

• Overview of the tool / using the tool
  • StateMachines are bound to Enums, and mostly communicated with using the enum
  • Designed for Unity, though it isn't required.
• Rationale
  • Meant to be a lightweight solution for state machines, that uses composition to enforce state calls, but doesn't impose inheritance.
  • Based off StateKit's StateKit Lite
  • States as collection callbacks instead of objects allows less boilerplate
  • Reflector utility allows users to easily create states without hiding functionality. Allows for custom function naming.
• Installation instructions
• Contributing

I'm curious if I can get to 100% test coverage. I've never checked my test coverage, so I'm going to need to do some research on this.