GE Lua Documentation

Press F to search!

SetTooltip

Definition


-- @/lua/common/extensions/ui/imgui_gen_luaintf.lua:862
function M.SetTooltip(string_fmt, ...)
  if string_fmt == nil then log("E", "", "Parameter 'string_fmt' of function 'SetTooltip' cannot be nil, as the c type is 'const char *'") ; return end
  string_fmt = formatStringIfArgs(string_fmt, ...)
  imgui.SetTooltip(string_fmt)
end

Callers

@/lua/ge/extensions/editor/api/valueInspector.lua

    if imgui.IsItemHovered() then
      imgui.SetTooltip("Clear Search Filter")
    end

          if imgui.IsItemHovered() and string.len(objName) >= tooltipLongTextLength then
            imgui.SetTooltip(objName)
          end

    if imgui.IsItemHovered() then
      imgui.SetTooltip("Clear Search Filter")
    end

              if imgui.IsItemHovered() and string.len(objName) >= tooltipLongTextLength then
                imgui.SetTooltip(objName)
              end

      if imgui.IsItemHovered() then
        imgui.SetTooltip("Clear Search Filter")
      end

            if imgui.IsItemHovered() and string.len(dbName) >= tooltipLongTextLength then
              imgui.SetTooltip(dbName)
            end

@/lua/ge/extensions/editor/dynamicDecals/history.lua

  if im.IsItemHovered() then
    im.SetTooltip("This will leave changes as they are. Warning, this action cannot be undone.")
  end

    if im.IsItemHovered() then
      im.SetTooltip(getTooltipTextFromAction(action))
    end

    if im.IsItemHovered() then
      im.SetTooltip(getTooltipTextFromAction(action))
    end

@/lua/ge/extensions/editor/undoHistory.lua

    if imgui.IsItemHovered() then
      imgui.SetTooltip("This will leave changes as they are. Warning, this action cannot be undone.")
    end

      if imgui.IsItemHovered() then
        imgui.SetTooltip(getTooltipTextFromAction(action))
      end

      if imgui.IsItemHovered() then
        imgui.SetTooltip(getTooltipTextFromAction(action))
      end

@/lua/ge/extensions/editor/materialEditor.lua

    if im.IsItemHovered() then
      im.SetTooltip("Save modifications of selected Cubemap")
    end

    if im.IsItemHovered() then
      im.SetTooltip("Create a new Cubemap under selected SceneTree group")
    end

    if im.IsItemHovered() then
      im.SetTooltip("Delete selected Cubemap")
    end

          if maxWidth < (im.CalcTextSize(matName).x + 2 * v.style.WindowPadding.x) then
            im.SetTooltip(matName)
          end

@/lua/ge/extensions/editor/visualization.lua

  end
  if im.IsItemHovered() then im.SetTooltip("Reset all preferences in this tab to their default values") end
  -- Reset confirmation

    im.PopID()
    if im.IsItemHovered() then im.SetTooltip("Filter Types") end
    -- Filter validator

@/lua/ge/extensions/core/ropeVisualTest.lua

        if im.IsItemHovered() then
          im.SetTooltip("Create a new rope with the current parameter settings")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Move camera to focus on the selected rope")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Rebuild the selected rope with current parameters")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Delete the currently selected rope")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Clone the selected rope 10 times with 20cm Y spacing each")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Delete all ropes and reset the simulation")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Delete all ropes except the first one")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Delete all ropes and reset the simulation")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Delete all ropes, reset everything, and unload the extension")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Save current rope parameters to JSON file")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Load rope parameters from JSON file")
        end

      if im.IsItemHovered() then
        im.SetTooltip("Select which rope to edit and view parameters for")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Controls the amplitude/intensity of rope endpoint animations (0 = no movement, 5x = maximum movement)")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Controls the speed of rope endpoint animations (0 = paused, 1.0 = normal speed, 5.0 = 5x speed)")
      end

        if im.IsItemHovered() then
          im.SetTooltip("Starting point of the rope - where it attaches")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Fix/unfix the starting anchor point (prevents movement if fixed)")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Select animation pattern for the starting anchor point")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Ending point of the rope - where it attaches")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Fix/unfix the ending anchor point (prevents movement if fixed)")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Select animation pattern for the ending anchor point")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Initial direction vector at the starting anchor point")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Reset starting direction vector to zero")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Initial direction vector at the ending anchor point")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Reset ending direction vector to zero")
        end

      if im.IsItemHovered() then
        im.SetTooltip("Number of simulation nodes in the rope (higher = more detailed but slower)")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Scales the rest length between anchor points (affects rope tension)")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Thickness of the rope (visual only, doesn't affect physics)")
      end

      if im.IsItemHovered() then
        im.SetTooltip("How much energy is lost per frame (higher = less bouncy, more stable)")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Total mass of the rope in kilograms")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Mass distribution along the rope (-1 = heavier at start, 1 = heavier at end)")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Solver iterations per update (1-10)")
      end

        if im.IsItemHovered() then
          im.SetTooltip("Per-rope gravity override (XYZ components)")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Gravity X component")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Gravity Y component")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Gravity Z component")
        end

      if im.IsItemHovered() then
        im.SetTooltip("Extended Position Based Dynamics - more stable but slower simulation")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Enable collision detection with world geometry")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Enable collision detection between rope segments")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Enable bending constraints in the rope simulation")
      end

        if im.IsItemHovered() then
          im.SetTooltip("How resistant the rope is to bending (0 = flexible, 1 = rigid)")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Number of segments spanned by bending constraints")
        end

      if im.IsItemHovered() then
        im.SetTooltip("Limit maximum strain to prevent rope breaking")
      end

        if im.IsItemHovered() then
          im.SetTooltip("Maximum allowed strain before rope breaks (1.0 = 100% stretch)")
        end

      if im.IsItemHovered() then
        im.SetTooltip("Material stiffness (higher = less stretchy, more like steel)")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Toggle rope geometry rendering on/off")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Strength of wind force applied to the rope")
      end

      if im.IsItemHovered() then
        im.SetTooltip("How much wind drag affects the rope movement")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Target simulation frames per second for rope physics")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Name of the material to use for rope rendering")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Debug visualization toggles")
      end

        if im.IsItemHovered() then
          im.SetTooltip("Show basic debug visualization of the rope")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Show debug text information for rope nodes")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Show individual rope nodes as spheres")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Show direction vectors at rope nodes")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Visualize node mass values")
        end

      if im.IsItemHovered() then
        im.SetTooltip("Manually rebuild the rope physics simulation")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Real-time rope simulation statistics")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Maximum strain (stretch) in any rope segment")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Average strain across all rope segments")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Current total length of the rope")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Target length of the rope when at rest")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Time taken for the last physics simulation step")
      end

    if im.IsItemHovered() then
      im.SetTooltip("Advanced performance metrics and frame analysis")
    end

    if im.IsItemHovered() then
      im.SetTooltip("Current frames per second")
    end

      if im.IsItemHovered() then
        im.SetTooltip("Percentage of target frame time (16.67ms @ 60FPS) used by ropes")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Total number of rope objects simulated and rendered")
      end

      if im.IsItemHovered() then
        im.SetTooltip(string.format("Average time spent simulating all rope physics (%.3f ms current)",
          perfStats.totalSimTime))

      if im.IsItemHovered() then
        im.SetTooltip(string.format("Average time spent rendering all rope visuals (%.3f ms current)",
          perfStats.totalRenderTime))

      if im.IsItemHovered() then
        im.SetTooltip("getRopeVisualManagerStats function not available")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Performance stats for each individual rope")
      end

      if im.IsItemHovered() then
        im.SetTooltip(string.format("Average simulation time per rope object (%d ropes with stats)",
          ropesWithStats))

@/lua/ge/extensions/editor/inspector.lua

          end
          if imgui.IsItemHovered() then imgui.SetTooltip("Unlock Inspector Window") end
        elseif editor.uiIconImageButton(editor.icons.lock_open, imgui.ImVec2(24, 24)) and (not tableIsEmpty(editor.selection)) then

        end
        if imgui.IsItemHovered() then imgui.SetTooltip("New Inspector Window") end
        if inspectorInfo.selection then

@/lua/common/extensions/ui/imgui_custom_luaintf.lua

    if M.IsItemHovered() then
      M.SetTooltip(message)
    end

@/lua/ge/extensions/editor/createObjectTool.lua

    if imgui.IsItemHovered() then
      imgui.SetTooltip("Click to select a SimObject derived class")
    end

          if hiddenClasses[result.name] and string.len(hiddenClasses[result.name]) > 0 then
            imgui.SetTooltip(string.format("Use %s for this class", hiddenClasses[result.name]))
          elseif string.len(result.name) >= tooltipLongTextLength then

            --TODO: maybe something better for longer strings not fitting in the popup width
            imgui.SetTooltip(result.name)
          end

    if imgui.IsItemHovered() then
      imgui.SetTooltip("Create the class instance in the currently selected folder or object's parent folder")
    end

@/lua/ge/extensions/util/vehicleRopeDebug.lua

          im.ColorButton("##FixedAHeader", im.ImVec4(0.2, 0.4, 0.8, 1.0), im.ColorEditFlags_NoTooltip, im.ImVec2(20, 20))
          if im.IsItemHovered() then im.SetTooltip("Fixed Anchor A - Blue spheres") end
        else

          im.ColorButton("##FreeAHeader", im.ImVec4(0.2, 0.8, 0.8, 1.0), im.ColorEditFlags_NoTooltip, im.ImVec2(20, 20))
          if im.IsItemHovered() then im.SetTooltip("Free Anchor A - Cyan spheres") end
        end

          im.ColorButton("##FixedBHeader", im.ImVec4(0.8, 0.2, 0.2, 1.0), im.ColorEditFlags_NoTooltip, im.ImVec2(20, 20))
          if im.IsItemHovered() then im.SetTooltip("Fixed Anchor B - Red spheres") end
        else

          im.ColorButton("##FreeBHeader", im.ImVec4(0.2, 0.8, 0.2, 1.0), im.ColorEditFlags_NoTooltip, im.ImVec2(20, 20))
          if im.IsItemHovered() then im.SetTooltip("Free Anchor B - Green spheres") end
        end

        im.Text("Base Pos:")
        if im.IsItemHovered() then im.SetTooltip("Base anchor position") end
        im.TableSetColumnIndex(1)

        im.Text("Calculated Position:")
        if im.IsItemHovered() then im.SetTooltip("Calculated anchor position") end
        im.TableSetColumnIndex(1)

        im.Text("Base Dir:")
        if im.IsItemHovered() then im.SetTooltip("Base direction vector") end
        im.TableSetColumnIndex(1)

        im.Text("Calculated Direction:")
        if im.IsItemHovered() then im.SetTooltip("Calculated direction vector") end
        im.TableSetColumnIndex(1)

      end
      if im.IsItemHovered() then im.SetTooltip("Fix/unfix anchor A") end
      im.SameLine()

      end
      if im.IsItemHovered() then im.SetTooltip("Fix/unfix anchor B") end

      if im.IsItemHovered() then
        im.SetTooltip("Number of simulation nodes in the rope (higher = more detailed but slower)")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Scales the rest length between anchor points (affects rope tension)")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Thickness of the rope (visual only, doesn't affect physics)")
      end

      if im.IsItemHovered() then
        im.SetTooltip("How much energy is lost per frame (higher = less bouncy, more stable)")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Total mass of the rope in kilograms")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Mass distribution along the rope (-1 = heavier at start, 1 = heavier at end)")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Solver iterations per update (1-10)")
      end

        if im.IsItemHovered() then
          im.SetTooltip("Per-rope gravity override (XYZ components)")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Gravity X component")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Gravity Y component")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Gravity Z component")
        end

      if im.IsItemHovered() then
        im.SetTooltip("Extended Position Based Dynamics - more stable but slower simulation")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Enable bending constraints in the rope simulation")
      end

        if im.IsItemHovered() then
          im.SetTooltip("How resistant the rope is to bending (0 = flexible, 1 = rigid)")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Number of segments spanned by bending constraints")
        end

      if im.IsItemHovered() then
        im.SetTooltip("Limit maximum strain to prevent rope breaking")
      end

        if im.IsItemHovered() then
          im.SetTooltip("Maximum allowed strain before rope breaks (1.0 = 100% stretch)")
        end

      if im.IsItemHovered() then
        im.SetTooltip("Material stiffness (higher = less stretchy, more like steel)")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Strength of wind force applied to the rope")
      end

      if im.IsItemHovered() then
        im.SetTooltip("How much wind drag affects the rope movement")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Target simulation frames per second for rope physics")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Name of the material to use for rope rendering")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Debug visualization toggles")
      end

        if im.IsItemHovered() then
          im.SetTooltip("Show basic debug visualization of the rope")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Show debug text information for rope nodes")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Show individual rope nodes as spheres")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Show direction vectors at rope nodes")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Visualize node mass values")
        end

        if im.IsItemHovered() then
          im.SetTooltip("Toggle rope geometry rendering on/off")
        end

      if im.IsItemHovered() then
        im.SetTooltip("Manually rebuild the rope physics simulation")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Real-time rope simulation statistics")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Maximum strain (stretch) in any rope segment")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Average strain across all rope segments")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Current total length of the rope")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Target length of the rope when at rest")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Time taken for the last physics simulation step")
      end

    if im.IsItemHovered() then
      im.SetTooltip("Advanced performance metrics and frame analysis")
    end

    if im.IsItemHovered() then
      im.SetTooltip("Current frames per second")
    end

      if im.IsItemHovered() then
        im.SetTooltip("Percentage of target frame time (16.67ms @ 60FPS) used by ropes")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Total number of rope objects simulated and rendered")
      end

      if im.IsItemHovered() then
        im.SetTooltip(string.format("Average time spent simulating all rope physics (%.3f ms current)",
          perfStats.totalSimTime))

      if im.IsItemHovered() then
        im.SetTooltip(string.format("Average time spent rendering all rope visuals (%.3f ms current)",
          perfStats.totalRenderTime))

      if im.IsItemHovered() then
        im.SetTooltip("getRopeVisualManagerStats function not available")
      end

      if im.IsItemHovered() then
        im.SetTooltip("Performance stats for each individual rope")
      end

      if im.IsItemHovered() then
        im.SetTooltip(string.format("Average simulation time per rope object (%d ropes with stats)",
          ropesWithStats))

@/lua/ge/extensions/editor/mainToolbar.lua

  end
  if im.IsItemHovered() then im.SetTooltip("Grid Size") end
  im.PopItemWidth()

  end
  if im.IsItemHovered() then im.SetTooltip("Rotate Snap Angle") end
  im.PopItemWidth()

  end
  if im.IsItemHovered() then im.SetTooltip("Toggle Terrain Snap. Right Click for options") end
  im.SameLine()

@/lua/ge/extensions/editor/preferences.lua

    end
    if imgui.IsItemHovered() then imgui.SetTooltip("Export the current category page preferences to a file, for sharing and backup") end

    end
    if imgui.IsItemHovered() then imgui.SetTooltip("Import the current category page preferences from a file (overwriting current values)") end
    imgui.SameLine()


    if imgui.IsItemHovered() then imgui.SetTooltip("Reset the current category preferences values to defaults") end

      end
      if imgui.IsItemHovered() then imgui.SetTooltip("Reset all preferences to their default values") end
      -- Reset-all confirmation

@/lua/ge/extensions/editor/sceneTree.lua

    end
    if imgui.IsItemHovered() then imgui.SetTooltip("New Inspector Window for the selected object(s)") end

      end
      if imgui.IsItemHovered() then imgui.SetTooltip("New subgroup (folder) in the selected group") end
      imgui.SameLine()

      imgui.PopID()
      if imgui.IsItemHovered() then imgui.SetTooltip("Search text") end
      imgui.SameLine()

      end
      if imgui.IsItemHovered() then imgui.SetTooltip("Search filter mode") end
      imgui.PopItemWidth()

      end
      if imgui.IsItemHovered() then imgui.SetTooltip("Only show near objects") end

@/lua/ge/extensions/editor/biomeTool.lua

    if imgui.IsItemHovered() and maskFile ~= "" then
      imgui.SetTooltip(maskFile)
    end

@/lua/ge/extensions/editor/forestEditor.lua

    if im.IsItemHovered() then
      im.SetTooltip("Clear Search Filter")
    end

          if im.IsItemHovered() and string.len(dbName) >= tooltipLongTextLength then
            im.SetTooltip(dbName)
          end

@/lua/common/extensions/ui/imgui_gen_luaintf.lua

  string_fmt = formatStringIfArgs(string_fmt, ...)
  imgui.SetTooltip(string_fmt)
end