Design Patterns Code for Unity Games
The core class for all 2D game objects in a Phase Jump project. Provides built-in common design pattern support for tags (custom properties attached to object), and state machines.
CullType cullType: Determines how this object is culled, if at all.
Bool dontModRotation: Default: false. If true, don’t mod rotation values between 0-360.0f and 0-1.0f.
string initialState: Initial state of Node.
bool isKinematic: Cached value, determined by rigidbody.
string State: Get/set the current string-based Node state.
Note: Strings are used for flexibility. If you prefer a concrete type, override the behavior.
List<NodeTag> nodeTags: Editor only. The Unity editor doesn’t support dictionaries, so we have to present this as a list, then transform it to a dictionary later.
Tags tags: Container for custom properties.
float RotationDegreeAngle: Value of 0-360.0f for the node’s rotation degree angle.
float RotationNormal: Value of 0-1.0f for the node’s normalized rotation degree angle.
NOTE: if property dontModRotation is true, this value can exceed the normalized float value range.
EvtStateChanged(SomeStateMachine): Called when the built in state machine changes state. Subclasses should override this method.
EvtStateFinished(SomeStateMachine): Called when a state machine state timer finishes. Subclasses can override this method.
Example: A state that lasts for N seconds.
HasTag(string name): Returns true if either a GameObject tag, or a type tag exists with a matching name.
Note: GameObject tags are defined in the Unity editor. PhaseJump tags are stored in the tags property inside Node2D.
MoveToPosition(Vector2 position, bool force): Moves the object to a specific position in 2D space.
Note: Generally this is not a good practice when simulating physics.
OnBecameInvisible: Optionally culls the object when it leaves the visible camera space, depending on the cullType property.
Core core: Propagates state machine message to the Node2D owner.
StateMachine<string> state: Default state machine for all Node2D objects. Uses string instead of a concrete type for flexibility.
Note: Subclasses of Node2D can implement their own state machines with concrete types as needed, but generally strings are easier to deal with.
Fairly stable.