Add Editor Setting for "Keep gizmo in view", Added documentation note on all datatypes for table key equality/hash consing

Author: PhoenixWhitefire

lsp/api-docs.json

@@ -501,7 +501,7 @@
     "documentation": "* An RGB color"
   },
   "@phoenix/global/Color.new": {
-    "documentation": "* Returns a Color with the provided R, G, and B values\n* Values are expected to be in the range 0 to 1"
+    "documentation": "* Returns a Color with the provided R, G, and B values\n* Values are expected to be in the range 0 to 1\n* This datatype is not hash consed! Two separate value-identical colors are not `rawequal` and will not behave as expected when used as table keys"
   },
   "@phoenix/global/Enum": {
     "documentation": "* Contains enumerations"
@@ -721,10 +721,10 @@
     "documentation": "* A connection to an Event"
   },
   "@phoenix/global/EventSignal": {
-    "documentation": "* An Event that can be connected to"
+    "documentation": "* An Event that can be connected to\n* This datatype is not hash consed! Two separate value-identical signals are not `rawequal` and will not behave as expected when used as table keys (e.g. `rawequal(game.OnFrameBegin, game.OnFrameBegin) == false`)"
   },
   "@phoenix/global/GameObject": {
-    "documentation": "* A Game Object\n* Game Objects have a \"base\" API (properties, methods, and events) that can be extended by giving them Components\n* The base API will be documented on the Component APIs page"
+    "documentation": "* A Game Object\n* Game Objects have a \"base\" API (properties, methods, and events) that can be extended by giving them Components\n* The base API will be documented on the Component APIs page\n* This datatype is hash consed, `t[game]` and `t[workspace.Parent]` are guaranteed to access the same value as `game` and `workspace.Parent` are `rawequal`"
   },
   "@phoenix/global/GameObject.fromId": {
     "documentation": "* Finds an Object by it's internal ID. Do not rely on the ID"
@@ -736,7 +736,7 @@
     "documentation": "* A list of all valid component names which can be passed into `.new`"
   },
   "@phoenix/global/Matrix": {
-    "documentation": "* A 4x4 transformation matrix"
+    "documentation": "* A 4x4 transformation matrix\n* This datatype is not hash consed! Two separate value-identical matrices are not `rawequal` and will not behave as expected when used as table keys"
   },
   "@phoenix/global/Matrix.fromAngles": {
     "documentation": "* Alias of `.fromEulerAnglesYXZ`"

resources/scripts/ed/CoreTools.luau

@@ -138,7 +138,7 @@ local function findDxDyToKeepOnScreen(Point: vector, ViewportRenderPosition: vec
     return dx, dy
 end
 
-local function _keepGizmoInView(target: GameObject & Transform, ViewportRenderPosition: vector, ViewportRenderSize: vector)
+local function keepGizmoInView(target: GameObject & Transform, ViewportRenderPosition: vector, ViewportRenderSize: vector, DeltaTime: number)
     assert(GizmoDragHandle)
 
     local cam = workspace.SceneCamera
@@ -157,7 +157,7 @@ local function _keepGizmoInView(target: GameObject & Transform, ViewportRenderPo
         end
     end
 
-    cam.Transform *= Matrix.fromAngles(-dy * orbitSpeed * 1/60, -dx * orbitSpeed * 1/60, 0)
+    cam.Transform *= Matrix.fromAngles(-dy * orbitSpeed * DeltaTime, -dx * orbitSpeed * DeltaTime, 0)
     cam.Transform *= Matrix.fromAngles(0, 0, -cam.Transform:ExtractAngles().z)
 
     if dx ~= 0 or dy ~= 0 then
@@ -170,7 +170,7 @@ local function _keepGizmoInView(target: GameObject & Transform, ViewportRenderPo
     GizmoDragPlaneNormal = vector.normalize(vector.cross(axisWorld, cam.Transform.Forward))
 end
 
-function CoreTools.Update(Project: Types.Project, ViewportRenderPosition: vector, ViewportRenderSize: vector)
+function CoreTools.Update(Project: Types.Project, EditorPreferences, ViewportRenderPosition: vector, ViewportRenderSize: vector, DeltaTime: number)
     if not Project.Workspace then
         return
     end
@@ -313,7 +313,9 @@ function CoreTools.Update(Project: Types.Project, ViewportRenderPosition: vector
         target.Transform = Matrix.fromTranslation(move) * GizmoDragStartTransform
         PrevDragMousePos = cpos
 
-        --keepGizmoInView(target, ViewportRenderPosition, ViewportRenderSize)
+        if EditorPreferences.KeepGizmoInView then
+            keepGizmoInView(target, ViewportRenderPosition, ViewportRenderSize, DeltaTime)
+        end
     end
 end
 

resources/scripts/ed/ed.luau

@@ -40,7 +40,8 @@ local EditorPreferences = {
 	UseLightTheme = false,
 	Gamma = 2.2,
 	ClosingProjectSaveRequiresConfirmation = false,
-	AutosaveInterval = 10
+	AutosaveInterval = 10,
+	KeepGizmoInView = false
 }
 
 EditorPreferences = EditorPreferences :: { [keyof<typeof(EditorPreferences)>]: index<typeof(EditorPreferences), keyof<typeof(EditorPreferences)>> } & typeof(EditorPreferences)
@@ -202,7 +203,7 @@ local function editorFrame(DeltaTime)
 
 	WasHoldingF5 = f5
 
-	CoreTools.Update(Project, ViewportRenderPosition, ViewportRenderSize)
+	CoreTools.Update(Project, EditorPreferences, ViewportRenderPosition, ViewportRenderSize, DeltaTime)
 	Stages[CurrentStage](DeltaTime)
 
 	WasHoldingDownM1 = PlayerInput:IsMouseButtonPressed(Enum.MouseButton.Left)
@@ -1192,6 +1193,7 @@ local function renderMainMenuBar(dt: number)
 		)
 
 		EditorPreferences.AutosaveInterval = imgui.inputnumber("Autosave interval (in minutes)", EditorPreferences.AutosaveInterval)
+		EditorPreferences.KeepGizmoInView = imgui.checkbox("Turn the camera to keep the gizmo handles in view while moving an object", EditorPreferences.KeepGizmoInView)
 
 		imgui.urllink("https://youtu.be/YCjNT9qGjh4?t=7193")
 
@@ -1407,7 +1409,7 @@ local function renderViewport(DeltaTime: number)
 	end
 
 	PluginManager.OnUpdate(DeltaTime, CurrentStage)
-	CoreTools.Update(Project, ViewportRenderPosition, ViewportRenderSize)
+	CoreTools.Update(Project, EditorPreferences, ViewportRenderPosition, ViewportRenderSize, DeltaTime)
 	HistoryView.Render()
 	TagViewer.Render()
 

src/impl/script/lib/lhxmatrix.cpp

@@ -304,7 +304,6 @@ static void createmetatable(lua_State* L)
 	lua_pushcfunction(L, mtx_newindex, "Matrix.__newindex");
 	lua_setfield(L, -2, "__newindex");
 
-	// TODO table key hashes?
 	lua_pushcfunction(L, mtx_eq, "Matrix.__eq");
 	lua_setfield(L, -2, "__eq");
 

wikigen/doc-comments.json

@@ -654,7 +654,8 @@
           "new": {
             "Description": [
               "Returns a Color with the provided R, G, and B values",
-              "Values are expected to be in the range 0 to 1"
+              "Values are expected to be in the range 0 to 1",
+              "This datatype is not hash consed! Two separate value-identical colors are not `rawequal` and will not behave as expected when used as table keys"
             ],
             "In": "R: number, G: number, B: number",
             "Out": "Color",
@@ -693,7 +694,10 @@
         }
       },
       "EventSignal": {
-        "Description": "An Event that can be connected to",
+        "Description": [
+          "An Event that can be connected to",
+          "This datatype is not hash consed! Two separate value-identical signals are not `rawequal` and will not behave as expected when used as table keys (e.g. `rawequal(game.OnFrameBegin, game.OnFrameBegin) == false`)"
+        ],
         "Members": {
           ":Connect": {
             "Description": "Connect a callback to the Event",
@@ -710,7 +714,8 @@
         "Description": [
           "A Game Object",
           "Game Objects have a \"base\" API (properties, methods, and events) that can be extended by giving them Components",
-          "The base API will be documented on the Component APIs page"
+          "The base API will be documented on the Component APIs page",
+          "This datatype is hash consed, `t[game]` and `t[workspace.Parent]` are guaranteed to access the same value as `game` and `workspace.Parent` are `rawequal`"
         ],
         "Library": {
           "fromId": {
@@ -730,7 +735,10 @@
         }
       },
       "Matrix": {
-        "Description": "A 4x4 transformation matrix",
+        "Description": [
+          "A 4x4 transformation matrix",
+          "This datatype is not hash consed! Two separate value-identical matrices are not `rawequal` and will not behave as expected when used as table keys"
+        ],
         "Library": {
           "fromAngles": {
             "Description": "Alias of `.fromEulerAnglesYXZ`",