sketchup-api-stubs 0.7.10 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (165) hide show
  1. checksums.yaml +4 -4
  2. data/lib/sketchup-api-stubs/sketchup.rb +12 -0
  3. data/lib/sketchup-api-stubs/stubs/Array.rb +5 -1
  4. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +37 -13
  5. data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +25 -15
  6. data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +17 -32
  7. data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +1 -1
  8. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +63 -40
  9. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +145 -109
  10. data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +56 -30
  11. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +81 -52
  12. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +45 -31
  13. data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +8 -16
  14. data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +135 -110
  15. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +212 -224
  16. data/lib/sketchup-api-stubs/stubs/Geom.rb +8 -6
  17. data/lib/sketchup-api-stubs/stubs/LanguageHandler.rb +5 -5
  18. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +54 -52
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +13 -8
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +1 -1
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +1 -1
  22. data/lib/sketchup-api-stubs/stubs/Layout/Dictionary.rb +234 -0
  23. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +125 -11
  24. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +1 -1
  25. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +1 -1
  26. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +112 -4
  27. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +7 -9
  28. data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +1 -1
  29. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +54 -4
  30. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +9 -11
  31. data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +1 -1
  32. data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +1 -1
  33. data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +1 -1
  34. data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +1 -1
  35. data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +56 -9
  36. data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +1 -1
  37. data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +1 -1
  38. data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +100 -1
  39. data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +13 -14
  40. data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +1 -1
  41. data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +6 -4
  42. data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +1 -1
  43. data/lib/sketchup-api-stubs/stubs/Layout/ReferenceEntity.rb +9 -11
  44. data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +7 -10
  45. data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +48 -2
  46. data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +18 -1
  47. data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +1 -1
  48. data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +1 -1
  49. data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +1 -1
  50. data/lib/sketchup-api-stubs/stubs/Layout.rb +1 -1
  51. data/lib/sketchup-api-stubs/stubs/Length.rb +9 -1
  52. data/lib/sketchup-api-stubs/stubs/Numeric.rb +1 -1
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +65 -13
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +110 -22
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +18 -12
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +2 -7
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +16 -3
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +13 -13
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +8 -14
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/CRSLocation.rb +402 -0
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/CRSMapUnit.rb +83 -0
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +10 -15
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +1 -1
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +2 -2
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +1 -1
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +247 -21
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +100 -24
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +1 -1
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +7 -12
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +1 -1
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +12 -10
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +9 -11
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +1 -1
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +1 -1
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +23 -21
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +36 -28
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +1 -1
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +11 -12
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +11 -14
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +2 -2
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +10 -10
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +237 -49
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +1 -1
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +1 -6
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +10 -3
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +1 -6
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/Environment.rb +406 -0
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/Environments.rb +185 -0
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/EnvironmentsObserver.rb +113 -0
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +3 -6
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +104 -33
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +2 -2
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +116 -45
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/HatchPattern.rb +277 -0
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/HatchPatternData.rb +245 -0
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/HatchPatterns.rb +155 -0
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +24 -17
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +11 -9
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +1 -1
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +6 -69
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +2 -2
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +2 -2
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +34 -8
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +1 -1
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +148 -3
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +20 -8
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +15 -45
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +3 -23
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +1 -9
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +1 -1
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +10 -3
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +1 -1
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +1 -1
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/LoadHandler.rb +70 -0
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +1 -1
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +894 -130
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +39 -26
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +1 -1
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +1 -1
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +253 -108
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +150 -9
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +14 -11
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +1 -1
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +1 -2
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/Overlay.rb +17 -44
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/OverlaysManager.rb +1 -13
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +247 -93
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +58 -31
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +1 -1
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +61 -40
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/Procedure.rb +452 -0
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +1 -1
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +40 -2
  134. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +1 -1
  135. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +31 -1
  136. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +84 -91
  137. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +1 -1
  138. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +1 -2
  139. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +22 -16
  140. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +1 -1
  141. data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +1 -1
  142. data/lib/sketchup-api-stubs/stubs/Sketchup/Snap.rb +125 -0
  143. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +36 -1
  144. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +59 -13
  145. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +103 -8
  146. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +13 -31
  147. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +9 -9
  148. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +276 -145
  149. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +1 -1
  150. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +26 -13
  151. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +1 -1
  152. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +23 -22
  153. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +411 -118
  154. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +34 -8
  155. data/lib/sketchup-api-stubs/stubs/Sketchup.rb +126 -40
  156. data/lib/sketchup-api-stubs/stubs/SketchupExtension.rb +83 -69
  157. data/lib/sketchup-api-stubs/stubs/String.rb +1 -1
  158. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +120 -153
  159. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +130 -14
  160. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +14 -3
  161. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +20 -3
  162. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +13 -7
  163. data/lib/sketchup-api-stubs/stubs/UI.rb +92 -22
  164. data/lib/sketchup-api-stubs/stubs/_top_level.rb +15 -7
  165. metadata +16 -28
@@ -1,38 +1,31 @@
1
- # Copyright:: Copyright 2024 Trimble Inc.
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
- # The SketchupExtension class contains methods allowing you to create and
5
- # manipulate SketchUp extensions. Extensions are Ruby scripts that can be
6
- # loaded and unloaded using the Extension manager (Extensions panel of the
7
- # Preferences dialog box). Generally you should register your ruby scripts as
8
- # an extension to give SketchUp users the ability to disable it through the
9
- # user interface.
4
+ # A SketchUp extension is a piece of software that extends the capabilities of
5
+ # SketchUp. It could be a new drawing tool, a content library or a way to
6
+ # automate a tedious and time consuming task.
10
7
  #
11
- # The idea here is to take the ruby script that actually creates your
12
- # functionality and place it in a folder somewhere outside of the /Plugins
13
- # folder, most commonly a subdirectory like /Plugins/MyExtension. Then
14
- # you create a new ruby script inside the /Plugins directory that will
15
- # set up the extension entry and load your original script if the user
16
- # has your extension turned on.
8
+ # The {SketchupExtension} handles the extension metadata, such as name,
9
+ # author and version, as well as a path to the main Ruby file with the
10
+ # actual functionality you want to add.
17
11
  #
18
- # Here is an example extension loading script. For this example, the
19
- # following code would be saved in /Plugins/StairTools.rb, and the
20
- # actual plugin itself would live in /Plugins/StairTools/core.rb.
12
+ # See {Extension Requirements}[file.extension_requirements.html]
21
13
  #
22
- # You can find two example extensions that ship with SketchUp,
23
- # su_dynamiccomponents.rb and su_sandboxtools.rb, under the /Plugins/ folder.
14
+ # See {Creating a SketchUp
15
+ # Extension}[https://developer.sketchup.com/article-creating-a-sketchup-extension]
24
16
  #
25
17
  # @example
26
- # # Create an entry in the Extension list that loads a script called
27
- # # core.rb.
28
18
  # require 'sketchup.rb'
29
19
  # require 'extensions.rb'
30
20
  #
31
- # stair_extension = SketchupExtension.new('Stair Tools", "StairTools/core.rb')
32
- # stair_extension.version = '1.0'
21
+ # stair_extension = SketchupExtension.new('Stair Tools', 'stair_tools/core')
22
+ # stair_extension.version = '1.0.0'
33
23
  # stair_extension.description = 'Tools to draw stairs automatically.'
34
24
  # Sketchup.register_extension(stair_extension, true)
35
25
  #
26
+ # @note By default Extension Warehouse encrypts extensions and convert .rb files to
27
+ # .rbe files. Omit the file extension to let SketchUp look for both.
28
+ #
36
29
  # @version SketchUp 6.0
37
30
  class SketchupExtension
38
31
 
@@ -40,12 +33,12 @@ class SketchupExtension
40
33
 
41
34
  # Loads the extension, meaning the underlying ruby script is immediately
42
35
  # interpreted. This is the equivalent of checking the extension's checkbox
43
- # in the Preferences > Extensions list.
36
+ # in the Extension Manager.
44
37
  #
45
38
  # @example
46
39
  # # This will register the extension, a necessary step for it to appear
47
- # # in SketchUp's Preferences > Extensions list
48
- # ext_c = SketchupExtension.new('Stair Tools C', 'StairTools/core.rb')
40
+ # # in SketchUp's Extension Manager > Extensions list
41
+ # ext_c = SketchupExtension.new('Stair Tools C', 'StairTools/core')
49
42
  # Sketchup.register_extension(ext_c, false)
50
43
  #
51
44
  # # And this will load the extension.
@@ -57,13 +50,13 @@ class SketchupExtension
57
50
  def check
58
51
  end
59
52
 
60
- # The copyright method returns the copyright string which appears beneath
53
+ # The {#copyright} method returns the copyright string which appears beneath
61
54
  # an extension inside the Extensions Manager dialog.
62
55
  #
63
56
  # @example
64
57
  # # Create an entry in the Extension list that loads a script called
65
- # # core.rb.
66
- # extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
58
+ # # core.
59
+ # extension = SketchupExtension.new('Stair Tools', 'StairTools/core')
67
60
  # extension.copyright = '2008'
68
61
  # copyright = extension.copyright
69
62
  #
@@ -73,13 +66,13 @@ class SketchupExtension
73
66
  def copyright
74
67
  end
75
68
 
76
- # The copyright= method sets the copyright string which appears beneath
69
+ # The {#copyright=} method sets the copyright string which appears beneath
77
70
  # an extension inside the Extensions Manager dialog.
78
71
  #
79
72
  # @example
80
73
  # # Create an entry in the Extension list that loads a script called
81
- # # core.rb.
82
- # extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
74
+ # # core.
75
+ # extension = SketchupExtension.new('Stair Tools', 'StairTools/core')
83
76
  # extension.copyright = '2008'
84
77
  # copyright = extension.copyright
85
78
  #
@@ -92,13 +85,13 @@ class SketchupExtension
92
85
  def copyright=(copyright)
93
86
  end
94
87
 
95
- # The creator method returns the creator string which appears beneath
88
+ # The {#creator} method returns the creator string which appears beneath
96
89
  # an extension inside the Extensions Manager dialog.
97
90
  #
98
91
  # @example
99
92
  # # Create an entry in the Extension list that loads a script called
100
- # # core.rb.
101
- # extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
93
+ # # core.
94
+ # extension = SketchupExtension.new('Stair Tools', 'StairTools/core')
102
95
  # extension.creator = 'Trimble Navigation, Inc.'
103
96
  # creator = extension.creator
104
97
  #
@@ -108,13 +101,13 @@ class SketchupExtension
108
101
  def creator
109
102
  end
110
103
 
111
- # The creator= method sets the creator string which appears beneath
104
+ # The {#creator=} method sets the creator string which appears beneath
112
105
  # an extension inside the Extensions Manager dialog.
113
106
  #
114
107
  # @example
115
108
  # # Create an entry in the Extension list that loads a script called
116
- # # core.rb.
117
- # extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
109
+ # # core.
110
+ # extension = SketchupExtension.new('Stair Tools', 'StairTools/core')
118
111
  # extension.creator = 'Trimble Navigation, Inc.'
119
112
  # creator = extension.creator
120
113
  #
@@ -127,13 +120,13 @@ class SketchupExtension
127
120
  def creator=(creator)
128
121
  end
129
122
 
130
- # The description method returns the long description which appears beneath
123
+ # The {#description} method returns the long description which appears beneath
131
124
  # an extension inside the Extensions Manager dialog.
132
125
  #
133
126
  # @example
134
127
  # # Create an entry in the Extension list that loads a script called
135
- # # core.rb.
136
- # extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
128
+ # # core.
129
+ # extension = SketchupExtension.new('Stair Tools', 'StairTools/core')
137
130
  # extension.description = 'My description.'
138
131
  # description = extension.description
139
132
  #
@@ -143,13 +136,13 @@ class SketchupExtension
143
136
  def description
144
137
  end
145
138
 
146
- # The description= method sets the long description which appears beneath
139
+ # The {#description=} method sets the long description which appears beneath
147
140
  # an extension inside the Extensions Manager dialog.
148
141
  #
149
142
  # @example
150
143
  # # Create an entry in the Extension list that loads a script called
151
- # # core.rb.
152
- # extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
144
+ # # core.
145
+ # extension = SketchupExtension.new('Stair Tools', 'StairTools/core')
153
146
  # extension.description = 'My description.'
154
147
  # description = extension.description
155
148
  #
@@ -162,7 +155,7 @@ class SketchupExtension
162
155
  def description=(description)
163
156
  end
164
157
 
165
- # The extension_path method returns the file system path to the extension's
158
+ # The {#extension_path} method returns the file system path to the extension's
166
159
  # outer rb file.
167
160
  #
168
161
  # @return [String] the file system path to the extension
@@ -171,7 +164,7 @@ class SketchupExtension
171
164
  def extension_path
172
165
  end
173
166
 
174
- # The id method returns the Extension Warehouse ID string.
167
+ # The {#id} method returns the Extension Warehouse ID string.
175
168
  #
176
169
  # @return [String] the Extension Warehouse ID
177
170
  #
@@ -186,7 +179,7 @@ class SketchupExtension
186
179
  #
187
180
  # @example
188
181
  # # Create an entry in the Extension list that loads a script called
189
- # # core.rb.
182
+ # # core.
190
183
  # extension = SketchupExtension.new('Stair Tools', 'StairTools/core')
191
184
  #
192
185
  # # Then be sure to register it. By passing a 2nd param of true, you're
@@ -210,13 +203,34 @@ class SketchupExtension
210
203
  def initialize(title, path)
211
204
  end
212
205
 
206
+ # Return the Ruby load error for an extension that failed to load.
207
+ #
208
+ # @example
209
+ # # broken/broken_file.rb
210
+ # raise "This file raises an exception"
211
+ #
212
+ # # broken.rb
213
+ # extension = SketchupExtension.new("Broken Extension", "broken/broken_file")
214
+ # extension.version = "1.0.0"
215
+ # extension.description = "This extension's has an error."
216
+ # Sketchup.register_extension(extension, true)
217
+ #
218
+ # extension.load_error
219
+ # # => RuntimeError
220
+ #
221
+ # @return [Exception, nil]
222
+ #
223
+ # @version SketchUp 2026.2
224
+ def load_error
225
+ end
226
+
213
227
  # Returns whether the extension is set to load when SketchUp starts up.
214
228
  #
215
229
  # @example
216
- # ext = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
217
- # UI.messagebox("load_on_start? is false: #{ext.load_on_start?.to_s}")
230
+ # ext = SketchupExtension.new('Stair Tools', 'StairTools/core')
231
+ # puts "load_on_start? is false: #{ext.load_on_start?.to_s}"
218
232
  # Sketchup.register_extension(ext, true)
219
- # UI.messagebox("load_on_start? is now true: #{ext.load_on_start?.to_s}")
233
+ # puts "load_on_start? is now true: #{ext.load_on_start?.to_s}"
220
234
  #
221
235
  # @return [Boolean]
222
236
  #
@@ -228,10 +242,10 @@ class SketchupExtension
228
242
  # script that implements the extension has been evaluated.
229
243
  #
230
244
  # @example
231
- # ext = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
232
- # UI.messagebox("loaded? is false: #{ext.loaded?.to_s}")
245
+ # ext = SketchupExtension.new('Stair Tools', 'StairTools/core')
246
+ # puts "loaded? is false: #{ext.loaded?.to_s}"
233
247
  # Sketchup.register_extension(ext, true)
234
- # UI.messagebox("loaded? is now true: #{ext.loaded?.to_s}")
248
+ # puts "loaded? is now true: #{ext.loaded?.to_s}"
235
249
  #
236
250
  # @return [Boolean]
237
251
  #
@@ -239,13 +253,13 @@ class SketchupExtension
239
253
  def loaded?
240
254
  end
241
255
 
242
- # The name method returns the name which appears for
256
+ # The {#name} method returns the name which appears for
243
257
  # an extension inside the Extensions Manager dialog.
244
258
  #
245
259
  # @example
246
260
  # # Create an entry in the Extension list that loads a script called
247
- # # core.rb.
248
- # extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
261
+ # # core.
262
+ # extension = SketchupExtension.new('Stair Tools', 'StairTools/core')
249
263
  # name = extension.name
250
264
  #
251
265
  # @return [String] the Extension name
@@ -254,13 +268,13 @@ class SketchupExtension
254
268
  def name
255
269
  end
256
270
 
257
- # The name= method sets the name which appears for
271
+ # The {#name=} method sets the name which appears for
258
272
  # an extension inside the Extensions Manager dialog.
259
273
  #
260
274
  # @example
261
275
  # # Create an entry in the Extension list that loads a script called
262
- # # core.rb.
263
- # extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
276
+ # # core.
277
+ # extension = SketchupExtension.new('Stair Tools', 'StairTools/core')
264
278
  # extension.name = 'Renamed Stair Tools'
265
279
  #
266
280
  # @param [String] name
@@ -276,10 +290,10 @@ class SketchupExtension
276
290
  # Sketchup.register_extension.
277
291
  #
278
292
  # @example
279
- # ext = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
280
- # UI.messagebox("My registered? is false: #{ext.registered?.to_s}")
293
+ # ext = SketchupExtension.new('Stair Tools', 'StairTools/core')
294
+ # puts "My registered? is false: #{ext.registered?.to_s}"
281
295
  # Sketchup.register_extension(ext, true)
282
- # UI.messagebox("Now registered? is now true: #{ext.registered?.to_s}")
296
+ # puts "Now registered? is now true: #{ext.registered?.to_s}"
283
297
  #
284
298
  # @return [Boolean]
285
299
  #
@@ -288,7 +302,7 @@ class SketchupExtension
288
302
  end
289
303
 
290
304
  # Unloads the extension. This is the equivalent of unchecking the extension's
291
- # checkbox in the Preferences > Extensions list.
305
+ # checkbox in the Extension Manager > Extensions list.
292
306
  #
293
307
  # Note that technically the extension is not "unloaded" in the sense that it
294
308
  # stops running during the current SketchUp session, but the next time the
@@ -307,13 +321,13 @@ class SketchupExtension
307
321
  def uncheck
308
322
  end
309
323
 
310
- # The version method returns the version which appears beneath
324
+ # The {#version} method returns the version which appears beneath
311
325
  # an extension inside the Extensions Manager dialog.
312
326
  #
313
327
  # @example
314
328
  # # Create an entry in the Extension list that loads a script called
315
- # # core.rb.
316
- # extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
329
+ # # core.
330
+ # extension = SketchupExtension.new('Stair Tools', 'StairTools/core')
317
331
  # extension.version = '5.0'
318
332
  # version = extension.version
319
333
  #
@@ -323,13 +337,13 @@ class SketchupExtension
323
337
  def version
324
338
  end
325
339
 
326
- # The version method sets the version which appears beneath
340
+ # The {#version=} method sets the version which appears beneath
327
341
  # an extension inside the Extensions Manager dialog.
328
342
  #
329
343
  # @example
330
344
  # # Create an entry in the Extension list that loads a script called
331
- # # core.rb.
332
- # extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
345
+ # # core.
346
+ # extension = SketchupExtension.new('Stair Tools', 'StairTools/core')
333
347
  # extension.version = '5.0'
334
348
  # version = extension.version
335
349
  #
@@ -342,7 +356,7 @@ class SketchupExtension
342
356
  def version=(version)
343
357
  end
344
358
 
345
- # The version_id method returns the Extension Warehouse Version ID string.
359
+ # The {#version_id} method returns the Extension Warehouse Version ID string.
346
360
  #
347
361
  # @return [String] the Extension Warehouse Version ID string
348
362
  #
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2024 Trimble Inc.
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The String class contains a method used to parse a string as a length value.