HackMDGodot 3.2 Docs Sprint: Let's complete the class reference
We use this shared document to work together on the Class Reference. Below, you'll see who is working on what at the moment, and a table with incomplete classes.
To contribute:
- Read the contribution guide.
- Review the list of incomplete classes at the end of this document and pick one you want to work on.
- Add the class you're working on, your name and the date to the Locked classes list below - remember to unlock them if you change your mind and stop working on them.
More info/help:
- See the last docs sprint blog post for more details and a video overview of the workflow.
- Join other documentation contributors on the
#documentationchannel on Godot's Discord: https://discord.gg/zH7NUgz
Useful links:
- Recent class reference changes
- Online class reference (auto-generated, don't edit the pages directly)
Locked classes
Write what you're working on and other contributors shouldn't edit (cleared on 2020-01-24):
Important: how to keep your local branch up-to-date
Pull request submitted, include #:
Incomplete classes on: 2020-01-28 (master)
Do not edit the table as changes will be lost on update.
Generated automatically with doc/tools/doc_status.py -bio doc/classes/ modules/*/doc_classes/
| –––––––––––––––––––- | –––––- | –––- | –––––- | –––- |
| Name | Brief Desc. | Desc. | Items | Overall |
|---|---|---|---|---|
| @C# | MISSING | MISSING | 0/0 | 0% |
| @NativeScript | MISSING | MISSING | 0/0 | 0% |
| Animation | OK | OK | 52/75 | 76% |
| AnimationNodeBlendTree | MISSING | MISSING | 0/16 | 0% |
| AnimationNodeOneShot | MISSING | MISSING | 0/10 | 0% |
| AnimationNodeOutput | MISSING | MISSING | 0/0 | 0% |
| AnimationNodeStateMachineTransition | MISSING | MISSING | 10/10 | 33% |
| AnimationNodeTimeScale | MISSING | MISSING | 0/0 | 0% |
| AnimationNodeTimeSeek | MISSING | MISSING | 0/0 | 0% |
| AnimationNodeTransition | MISSING | MISSING | 0/6 | 0% |
| AnimationRootNode | MISSING | MISSING | 0/0 | 0% |
| AnimationTrackEditPlugin | MISSING | MISSING | 0/0 | 0% |
| AnimationTree | MISSING | MISSING | 0/11 | 0% |
| AudioEffectChorus | OK | OK | 27/39 | 80% |
| AudioEffectDistortion | OK | OK | 9/10 | 97% |
| AudioEffectFilter | OK | OK | 3/8 | 82% |
| AudioEffectHighShelfFilter | MISSING | MISSING | 0/0 | 0% |
| AudioEffectInstance | MISSING | MISSING | 0/0 | 0% |
| AudioEffectLimiter | OK | OK | 3/4 | 96% |
| AudioEffectLowShelfFilter | MISSING | MISSING | 0/0 | 0% |
| AudioEffectPitchShift | OK | OK | 2/9 | 76% |
| AudioEffectRecord | MISSING | MISSING | 0/4 | 0% |
| AudioEffectSpectrumAnalyzer | MISSING | MISSING | 1/9 | 3% |
| AudioEffectSpectrumAnalyzerInstance | MISSING | MISSING | 2/3 | 9% |
| AudioEffectStereoEnhance | MISSING | MISSING | 0/3 | 0% |
| AudioStreamGenerator | MISSING | MISSING | 0/2 | 0% |
| AudioStreamGeneratorPlayback | MISSING | MISSING | 0/6 | 0% |
| AudioStreamMicrophone | MISSING | MISSING | 0/0 | 0% |
| AudioStreamPlaybackResampled | MISSING | MISSING | 0/0 | 0% |
| BakedLightmap | OK | OK | 18/23 | 88% |
| BakedLightmapData | MISSING | MISSING | 0/10 | 0% |
| BitMap | OK | OK | 7/9 | 93% |
| BulletPhysicsDirectBodyState | MISSING | MISSING | 0/0 | 0% |
| BulletPhysicsServer | MISSING | MISSING | 0/0 | 0% |
| CSharpScript | MISSING | MISSING | 0/1 | 0% |
| CheckBox | OK | OK | 1/18 | 55% |
| CheckButton | OK | OK | 1/18 | 55% |
| CollisionPolygon2D | OK | OK | 6/7 | 96% |
| ColorPicker | OK | OK | 13/24 | 75% |
| ColorPickerButton | OK | OK | 7/19 | 69% |
| ConeTwistJoint | OK | OK | 11/13 | 94% |
| ConfigFile | OK | OK | 9/14 | 85% |
| EditorExportPlugin | MISSING | MISSING | 0/11 | 0% |
| EditorFeatureProfile | MISSING | MISSING | 1/19 | 3% |
| EditorFileDialog | MISSING | MISSING | 25/25 | 56% |
| EditorFileSystem | OK | OK | 11/13 | 94% |
| EditorFileSystemDirectory | OK | OK | 12/14 | 94% |
| EditorImportPlugin | OK | OK | 10/12 | 94% |
| EditorInspector | MISSING | MISSING | 0/8 | 0% |
| EditorInterface | OK | OK | 19/24 | 89% |
| EditorNavigationMeshGenerator | MISSING | MISSING | 0/2 | 0% |
| EditorPlugin | OK | OK | 39/78 | 60% |
| EditorResourceConversionPlugin | MISSING | MISSING | 0/2 | 0% |
| EditorSceneImporter | OK | MISSING | 0/16 | 28% |
| EditorSettings | OK | OK | 10/18 | 79% |
| EditorSpatialGizmo | OK | OK | 12/17 | 86% |
| EditorSpatialGizmoPlugin | OK | OK | 16/17 | 97% |
| EditorSpinSlider | MISSING | MISSING | 0/3 | 0% |
| FileDialog | OK | OK | 25/31 | 88% |
| Font | OK | OK | 8/10 | 93% |
| GDNative | MISSING | MISSING | 0/4 | 0% |
| GDScriptFunctionState | OK | OK | 2/3 | 96% |
| GDScriptNativeClass | MISSING | MISSING | 0/1 | 0% |
| GIProbeData | MISSING | MISSING | 0/11 | 0% |
| Generic6DOFJoint | OK | OK | 82/121 | 72% |
| GodotSharp | MISSING | MISSING | 4/8 | 14% |
| GraphEdit | OK | OK | 33/47 | 79% |
| GraphNode | OK | OK | 32/51 | 73% |
| GridContainer | OK | OK | 1/3 | 91% |
| GridMap | OK | OK | 23/29 | 88% |
| HSeparator | OK | OK | 0/2 | 91% |
| HSlider | OK | OK | 0/6 | 77% |
| HSplitContainer | OK | OK | 0/4 | 83% |
| HTTPRequest | OK | OK | 22/25 | 93% |
| HingeJoint | OK | OK | 20/26 | 87% |
| InputEventGesture | MISSING | MISSING | 0/1 | 0% |
| InputEventMIDI | MISSING | MISSING | 0/8 | 0% |
| InputEventMagnifyGesture | MISSING | MISSING | 0/1 | 0% |
| InputEventPanGesture | MISSING | MISSING | 0/1 | 0% |
| InstancePlaceholder | OK | OK | 2/4 | 92% |
| ItemList | OK | OK | 61/75 | 85% |
| JSONRPC | MISSING | MISSING | 0/12 | 0% |
| JavaClass | MISSING | MISSING | 0/0 | 0% |
| JavaClassWrapper | MISSING | MISSING | 0/1 | 0% |
| LinkButton | OK | OK | 3/11 | 74% |
| MenuButton | OK | OK | 4/15 | 69% |
| MultiplayerPeerGDNative | MISSING | MISSING | 0/0 | 0% |
| NativeScript | MISSING | MISSING | 5/9 | 17% |
| NavigationMesh | MISSING | MISSING | 0/36 | 0% |
| NavigationMeshInstance | MISSING | MISSING | 0/2 | 0% |
| NavigationPolygonInstance | MISSING | MISSING | 0/2 | 0% |
| OptionButton | OK | OK | 24/37 | 77% |
| PackedDataContainer | MISSING | MISSING | 0/3 | 0% |
| PackedDataContainerRef | MISSING | MISSING | 0/1 | 0% |
| PacketPeerGDNative | MISSING | MISSING | 0/0 | 0% |
| PacketPeerStream | OK | OK | 1/3 | 91% |
| Panel | OK | OK | 0/1 | 95% |
| PanelContainer | OK | OK | 0/1 | 95% |
| PhysicalBone | MISSING | MISSING | 0/20 | 0% |
| Physics2DDirectSpaceState | OK | OK | 6/7 | 96% |
| Physics2DServer | OK | OK | 143/166 | 88% |
| Physics2DTestMotionResult | MISSING | MISSING | 0/9 | 0% |
| PhysicsDirectBodyState | OK | OK | 29/31 | 96% |
| PhysicsMaterial | OK | OK | 2/4 | 92% |
| PhysicsServer | OK | OK | 217/238 | 92% |
| PinJoint | OK | OK | 6/8 | 93% |
| PluginScript | MISSING | MISSING | 1/1 | 5% |
| Polygon2D | OK | OK | 13/25 | 73% |
| PolygonPathFinder | MISSING | MISSING | 0/8 | 0% |
| PopupPanel | OK | OK | 0/1 | 95% |
| ProgressBar | OK | OK | 1/6 | 81% |
| ProximityGroup | OK | OK | 0/7 | 74% |
| ProxyTexture | MISSING | MISSING | 0/1 | 0% |
| ResourceFormatLoaderCrypto | MISSING | MISSING | 0/0 | 0% |
| ResourceFormatSaverCrypto | MISSING | MISSING | 0/0 | 0% |
| ResourceImporter | MISSING | MISSING | 0/0 | 0% |
| RichTextLabel | OK | OK | 54/90 | 67% |
| RootMotionView | MISSING | MISSING | 0/5 | 0% |
| Script | OK | OK | 9/14 | 85% |
| ScriptEditor | MISSING | MISSING | 5/9 | 17% |
| ScrollContainer | OK | OK | 10/11 | 97% |
| Skeleton | OK | OK | 16/28 | 75% |
| Skeleton2D | OK | MISSING | 1/4 | 46% |
| SkeletonIK | MISSING | MISSING | 0/14 | 0% |
| Skin | MISSING | MISSING | 0/8 | 0% |
| SkinReference | MISSING | MISSING | 0/2 | 0% |
| SliderJoint | OK | OK | 45/47 | 97% |
| SoftBody | OK | OK | 13/20 | 83% |
| SpatialGizmo | MISSING | MISSING | 0/0 | 0% |
| SpatialVelocityTracker | MISSING | MISSING | 0/4 | 0% |
| SpriteBase3D | OK | OK | 15/24 | 80% |
| StreamPeerBuffer | MISSING | MISSING | 0/7 | 0% |
| StreamPeerGDNative | MISSING | MISSING | 0/0 | 0% |
| StreamPeerSSL | OK | OK | 8/11 | 90% |
| StreamTexture | OK | OK | 1/2 | 95% |
| TabContainer | OK | OK | 25/44 | 70% |
| Tabs | OK | OK | 37/56 | 75% |
| TextEdit | OK | OK | 94/127 | 78% |
| TextFile | MISSING | MISSING | 0/0 | 0% |
| TextureLayered | OK | OK | 0/14 | 59% |
| TextureProgress | OK | OK | 24/26 | 96% |
| TileSet | OK | OK | 63/83 | 81% |
| Tree | OK | OK | 51/90 | 65% |
| TreeItem | OK | OK | 61/71 | 89% |
| VSeparator | OK | OK | 0/2 | 91% |
| VSlider | OK | OK | 0/6 | 77% |
| VSplitContainer | OK | OK | 0/4 | 83% |
| Viewport | OK | OK | 88/92 | 96% |
| VisualScriptBuiltinFunc | OK | OK | 63/70 | 92% |
| VisualScriptConstructor | OK | OK | 0/4 | 83% |
| VisualScriptCustomNode | OK | OK | 21/22 | 98% |
| VisualScriptEditor | MISSING | MISSING | 3/3 | 13% |
| VisualScriptExpression | MISSING | MISSING | 0/0 | 0% |
| VisualScriptFunction | MISSING | MISSING | 0/0 | 0% |
| VisualScriptFunctionCall | MISSING | MISSING | 0/20 | 0% |
| VisualScriptFunctionState | MISSING | MISSING | 0/3 | 0% |
| VisualScriptGlobalConstant | MISSING | MISSING | 0/1 | 0% |
| VisualScriptIndexGet | MISSING | MISSING | 0/0 | 0% |
| VisualScriptIndexSet | MISSING | MISSING | 0/0 | 0% |
| VisualScriptInputAction | MISSING | MISSING | 0/6 | 0% |
| VisualScriptLists | OK | OK | 0/8 | 71% |
| VisualScriptOperator | MISSING | OK | 0/2 | 45% |
| VisualScriptPropertyGet | MISSING | MISSING | 0/10 | 0% |
| VisualScriptPropertySet | MISSING | MISSING | 0/23 | 0% |
| VisualScriptResourcePath | MISSING | MISSING | 0/1 | 0% |
| VisualScriptSceneTree | MISSING | MISSING | 0/0 | 0% |
| VisualScriptSubCall | MISSING | MISSING | 0/1 | 0% |
| VisualScriptTypeCast | MISSING | MISSING | 0/2 | 0% |
| VisualScriptYield | MISSING | MISSING | 0/5 | 0% |
| VisualScriptYieldSignal | MISSING | MISSING | 0/7 | 0% |
| VisualShader | OK | OK | 1/21 | 51% |
| VisualShaderNode | MISSING | MISSING | 12/12 | 38% |
| VisualShaderNodeIf | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeInput | MISSING | MISSING | 0/3 | 0% |
| VisualShaderNodeIs | MISSING | MISSING | 0/3 | 0% |
| VisualShaderNodeOuterProduct | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeOutput | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeScalarClamp | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeScalarConstant | MISSING | MISSING | 0/1 | 0% |
| VisualShaderNodeScalarDerivativeFunc | MISSING | MISSING | 0/4 | 0% |
| VisualShaderNodeScalarFunc | MISSING | MISSING | 0/33 | 0% |
| VisualShaderNodeScalarInterp | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeScalarOp | MISSING | MISSING | 0/11 | 0% |
| VisualShaderNodeScalarSmoothStep | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeScalarSwitch | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeScalarUniform | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeSwitch | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeTexture | MISSING | MISSING | 0/12 | 0% |
| VisualShaderNodeTextureUniform | MISSING | MISSING | 0/8 | 0% |
| VisualShaderNodeTextureUniformTriplanar | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeTransformCompose | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeTransformConstant | MISSING | MISSING | 0/1 | 0% |
| VisualShaderNodeTransformDecompose | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeTransformFunc | MISSING | MISSING | 0/3 | 0% |
| VisualShaderNodeTransformMult | MISSING | MISSING | 0/5 | 0% |
| VisualShaderNodeTransformUniform | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeTransformVecMult | MISSING | MISSING | 0/5 | 0% |
| VisualShaderNodeUniform | MISSING | MISSING | 0/1 | 0% |
| VisualShaderNodeVec3Constant | MISSING | MISSING | 0/1 | 0% |
| VisualShaderNodeVec3Uniform | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeVectorClamp | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeVectorCompose | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeVectorDecompose | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeVectorDerivativeFunc | MISSING | MISSING | 0/4 | 0% |
| VisualShaderNodeVectorDistance | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeVectorFunc | MISSING | MISSING | 0/36 | 0% |
| VisualShaderNodeVectorInterp | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeVectorLen | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeVectorOp | MISSING | MISSING | 0/13 | 0% |
| VisualShaderNodeVectorRefract | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeVectorScalarMix | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeVectorScalarSmoothStep | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeVectorScalarStep | MISSING | MISSING | 0/0 | 0% |
| VisualShaderNodeVectorSmoothStep | MISSING | MISSING | 0/0 | 0% |
| WebRTCDataChannel | MISSING | MISSING | 18/18 | 47% |
| WebRTCDataChannelGDNative | MISSING | MISSING | 0/0 | 0% |
| WebRTCPeerConnectionGDNative | MISSING | MISSING | 0/0 | 0% |
| WindowDialog | OK | OK | 3/12 | 72% |
| –––––––––––––––––––- | –––––- | –––- | –––––- | –––- |
| Total = 218 | MISSING | MISSING | 9413/10673 | 88% |
| –––––––––––––––––––- | –––––- | –––- | –––––- | –––- |
