FiniteStateMachine icon indicating copy to clipboard operation
FiniteStateMachine copied to clipboard

Wording "using a function"

Open Kaligule opened this issue 5 years ago • 1 comments

function documentation

In FSM2D (and possibly other places too) we can read:

# update(inDeltaTime): update FSM to update current state. Should be # used in every game tick, but should use it only if you are using # updateMode="Manual".

The last sentence is not clear to me. After thinking about it I guess it should be:

Should be called in every game tick, but only if you are using updateMode="Manual".

section

The whole section suffers a bit from the expression "use a function". This could be understood in two ways:

  • adapt the function (for example, to use the function _physics_process in Godot nodes you just have to write something into it - no need to call it manually)
  • call the function

I think the later meaning is the intended one here. Perhaps we should replace the "use" with "call" in most of thissection

Kaligule avatar Jun 04 '19 06:06 Kaligule

hey, when it comes to this sentence you were wondering about - you are right Should be called in every game tick, but only if you are using updateMode="Manual". is more to the point

kubecz3k avatar Aug 28 '19 07:08 kubecz3k