From ef9d4d0dcdebbd5ed314cb874e373031cae08438 Mon Sep 17 00:00:00 2001 From: realtradam Date: Mon, 3 Jan 2022 08:25:17 -0500 Subject: . --- docs/file.README.html | 38 +++++++++++++++++++++++++++++++++++--- 1 file changed, 35 insertions(+), 3 deletions(-) (limited to 'docs/file.README.html') diff --git a/docs/file.README.html b/docs/file.README.html index e075115..f62e0db 100644 --- a/docs/file.README.html +++ b/docs/file.README.html @@ -80,7 +80,8 @@ * Entities * Systems * Scenes - * Stage + * Stage + * Order
  • Usage
    • +
  • Order + +
  • Closing Notes
  • Contribution
    • @@ -169,7 +175,7 @@ ECS stands for Entity, Component, and System.

    By using this pattern it allows programmers to easily control what an "object" or entity can do and how much data it needs to have. It avoids the issue of inhertance as no inhertance is ever required in this system. If you need a certain entity to have a certain functionality you just add the relevant component to it, and the systems that automatically go over specific components will give your entitiy the desired functionality.

    -

    "But your framework also has Scenes and a Stage, what is that about?"

    +

    "But your framework also has Scenes, Stage, and Order, what is that about?"

    @@ -181,6 +187,10 @@ ECS stands for Entity, Component, and System.

    The Stage is Scenes which are activated. This means any Scenes on the Stage are executed each frame, while the rest of the Systems are not.

    +

    Order

    + +

    Order is a helper class which can set the priority of Scenes and Systems.

    +

    Usage

    @@ -504,6 +514,28 @@ E.g priority 1 will go first, priority 2 will go second, etcetera. 

    FelFlame::Stage.call
    +

    Order

    + +

    Setting the order

    + +

    To set the order you just need to call FelFlame::Order.sort and pass Scenes or Systems in the parameters in the order you wish for them to execute

    + +
    FelFlame::Order.sort(
+  @system1,
+  @system2,
+  @system3
+)
+
    + +

    If you want some Scenes or Systems to have the same priority then just pass them as an array:

    + +
    FelFlame::Order.sort(
+  @scene1,
+  [@scene2_1, @scene2_2],
+  @scene3
+) 
+
    +

    Closing Notes

    There are some methods I haven't gone over in the overview. If you want to see everything and read in more detail check out the Documentation!

    @@ -518,7 +550,7 @@ E.g priority 1 will go first, priority 2 will go second, etcetera.

    -- cgit v1.2.3