Start Documenting Roblox's Standard Scripts

[karl-police]

Checks

By submitting your pull request for review, you agree to the following:

• This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses.
• I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses.
• To the best of my knowledge, all proposed changes are accurate.

Changes

The changes introduce early documentation about Roblox's Standard Scripts. This is important because things like the CameraModule do things is important to know about. For instance, the RenderPriority of the Camera and how it changes the CFrame of the camera. Otherwise, it causes confusion.

The current text and information is through careful analyzing and from Roblox's own comments within the code. There is not much documentation yet, because I happen to find bugs that need to be resolved before this documentation can continue. Until then, I want to share my vision on how these documentation could be structured and look like and hope to have this PR accepted, which provide this initial set up for documenting Roblox's Standard Scripts, as I did all these changes just by using the GitHub websites. I even had to temporarily change .gitattributes just to upload a PNG.

It also adds info about BoundKeys which is a StringValue that is comma-separated and can be overwritten to change the bindings for Shift-Lock.

This documentation is necessary so that there's also official guidelines on what can be done and what shouldn't be done. Keep in mind that the PlayerModule says that a Creator is allowed to access things that it provides, but never had a documentation.

Bug Reports:

• https://devforum.roblox.com/t/robloxs-cameramodule-doesnt-ever-return-the-camera-to-the-playermodule/4451947

[karl-police]

test

[IgnisRBX]

Hi @karl-police ,
Thanks for the initial submission. I'm a bit hesitant on how much these scripts should be officially documented, honestly. I know that many creators clone them from a running game and modify them, and perhaps that's a great approach for their situation, but it's also a fairly "fragile" approach since these scripts change over time (without notice) and so the clones must be kept in continual sync with the new core changes and creator-applied modifications.

Are there specific points that you'd like clarified from these scripts, such as camera rendering details that may not be well documented (or perhaps not at all) under related guides and API docs for Camera? If so, perhaps we can work in those details to other places...

[karl-police]

Hi @karl-police , Thanks for the initial submission. I'm a bit hesitant on how much these scripts should be officially documented, honestly. I know that many creators clone them from a running game and modify them, and perhaps that's a great approach for their situation, but it's also a fairly "fragile" approach since these scripts change over time (without notice) and so the clones must be kept in continual sync with the new core changes and creator-applied modifications.

Are there specific points that you'd like clarified from these scripts, such as camera rendering details that may not be well documented (or perhaps not at all) under related guides and API docs for Camera? If so, perhaps we can work in those details to other places...

The camera rendering. It could go to RenderStepped and BindToRenderStep to give the clue on what to watch out for.

e.g.

• BindRenderStep 1# Changes Camera CFrame

• BindRenderStep 2# Fires raycast from camera

• BindRenderStep 3# Changes Camera CFrame again

• RenderStep RNG <-- this render step initialized first in the code

• RenderStep RNG 2# <-- this render step may also initialize first

One of these RenderStep fires a cast, while the other one changes the camera. If the cast happens before the camera change, you may get a unexpected result. But "RNG" because it's a race condition on which one "Connects" first.

Something like that.

 

For the other things. The ObjectValues where you can change the keybinds, I think these are super specific to the Roblox Standard Scripts, yet useful. Since these scripts change overtime, maybe older documentation about them could get archived 🤷 but still be available in the Creator Docs

[karl-police]

Found this old page: https://web.archive.org/web/20200304050359/https://developer.roblox.com/en-us/articles/customizing-game-controls

There's also a few other pages that I used to know about once. Like this one: https://web.archive.org/web/20191014231924/https://developer.roblox.com/en-us/articles/Bezier-curves
https://web.archive.org/web/20230214174739/https://create.roblox.com/docs/mechanics/bezier-curves

But I think there was another one with ease-in I think.

Not this one: https://web.archive.org/web/20120803044539/http://wiki.roblox.com/index.php/Parametric_equations

It was something else. It was like EasingStyle but with math instead.

Doesn't seem to be this one either https://web.archive.org/web/20180805200548/http://robloxdev.com:80/articles/Lerp

I didn't even know pages like these existed: https://web.archive.org/web/20180207161209/http://wiki.roblox.com/index.php?title=Quaternion

[karl-police]

Also note

FFlagUserPlayerModuleHiddenAPI