stride3d / stride-docs

This repository hosts the source code for the Stride documentation. Contributors can follow the build instructions provided to run the website locally.

Home Page:https://doc.stride3d.net/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

StartupScript type does not have comments explaining what it is

VaclavElias opened this issue · comments

Pointed out in Discord by OmniOwl

image

It says "update loop". But the SyncScript type is derived from StartupScript and is where the Update function is introduced. So the StartupScript talking about update loops outside of the SyncScript that derives from it and introduces the Update method is a bit confusing I must say.
Because it implies that the StartupScript has an Update method I can't see or a loop that is part of its life-cycle by default that I cannot access or see.

We should probably go over the Classes that are commonly used by devs.

StartupScript, SyncScript, ScriptComponent etc. this should be a simple cleanup to tackle.

I am glad that we also figured out how to add examples from the external source..