RutgersGRID / CYOA_Game_Package

new repo for WebGL Build
0 stars 0 forks source link

Refactor step 1 - Clean up UI element names - As a unity developer, I would like to have the UI element names more accurately reflect what they control to make it easier to update. #10

Open HornOfSaltff opened 3 months ago

HornOfSaltff commented 3 months ago

Rename UI elements so they more clearly explain what they are

Example Issues in UI naming:

"Props" is nice and clear "dlog-bg" is less clear until you realize that "dlog" is dialogue. Some are capitalized, some are not. Some use dashes, some don't Some are camelCase, some are PascalCase, some are Kebab-Case - let's be consistent. Some are very specific of what they container ("Props"), some are not-quite-accurate ("dlog-elements" is really scene elements or display elements)

Suggested fixes

Let's make these all PascalCase (first letter of each word capitalized) Let's spell out abbreviations to avoid confusion. Let's use the word container to help us all understand what these are a little more clearly For example, the top-level for a scene (unless I'm misreading these) is currently "dlog-elements", but that isn't accurate, as this is a container for all the pieces of a single scene/screen, including non-dialogue. So it should probably be SceneElementsContainer because it will contain all the elements of the scene. Props should probably be propsContainer

HornOfSaltff commented 3 months ago

Scriptable Object Variables > PascalCase Methods > PascalCase Script Variables > camelCase UI Elements > PascalCase

HornOfSaltff commented 3 months ago

Step 1 Completed for CYOA Scene