kubecz3k / FiniteStateMachine

FSM plugin for Godot
MIT License
116 stars 22 forks source link

Wording "using a function" #29

Open Kaligule opened 5 years ago

Kaligule commented 5 years ago

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:

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

kubecz3k commented 4 years ago

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