# Godot 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: - Add the class you're working on and your name to the Locked classes list below - Read the contribution guide: http://docs.godotengine.org/en/latest/community/contributing/updating_the_class_reference.html - **You can now write all methods!** Setters and getters were removed from the repo so everything that's left needs documentation: even if the method name starts with set_* or get_* Useful links: 1. [Recent class reference changes](https://github.com/godotengine/godot/commits/master/doc) 1. [Online class reference](http://docs.godotengine.org/en/latest/classes/_classes.html) (*auto-generated, don't edit the pages directly*) ------------------------------ ## Locked Classes Write what you're working on and other contributors shouldn't edit (cleared on 2019-06-25): - GDquest: all AnimationNode\* classes - Zak Stam: String, all Control\* classes - Akien: OS, String, Theme - *Your name here and the class(es) you're working on* **Important**: [how to keep your local branch up-to-date](http://docs.godotengine.org/en/latest/community/contributing/updating_the_class_reference.html#keeping-your-local-clone-up-to-date) ------------------------------ Classes documented locally, not pushed yet to the repo (provide author): - ------------------------------ Pull request submitted, include #: - ------------------------------ Proofreading requested, just post URLs: - ------------------------------ Incomplete classes on: 2019-06-25 (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% | | @GlobalScope | OK | OK | 465/529 | 88% | | @NativeScript | MISSING | MISSING | 0/0 | 0% | | ARVRServer | OK | OK | 23/27 | 91% | | Animation | OK | OK | 52/75 | 76% | | AnimationNodeBlendTree | MISSING | MISSING | 0/16 | 0% | | AnimationNodeOneShot | MISSING | MISSING | 0/10 | 0% | | AnimationNodeOutput | MISSING | MISSING | 0/0 | 0% | | AnimationNodeStateMachinePlayback | OK | OK | 5/6 | 96% | | AnimationNodeStateMachineTransition | MISSING | MISSING | 9/10 | 30% | | AnimationNodeTimeScale | MISSING | MISSING | 0/0 | 0% | | AnimationNodeTimeSeek | MISSING | MISSING | 0/0 | 0% | | AnimationNodeTransition | MISSING | MISSING | 0/66 | 0% | | AnimationPlayer | OK | OK | 40/42 | 97% | | AnimationRootNode | MISSING | MISSING | 0/0 | 0% | | AnimationTrackEditPlugin | MISSING | MISSING | 0/0 | 0% | | AnimationTree | MISSING | MISSING | 0/11 | 0% | | AnimationTreePlayer | OK | OK | 72/73 | 99% | | ArrayMesh | OK | OK | 38/39 | 98% | | 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% | | AudioServer | OK | OK | 38/49 | 84% | | AudioStreamGenerator | MISSING | MISSING | 0/2 | 0% | | AudioStreamGeneratorPlayback | MISSING | MISSING | 0/6 | 0% | | AudioStreamMicrophone | MISSING | MISSING | 0/0 | 0% | | AudioStreamOGGVorbis | OK | OK | 1/3 | 91% | | AudioStreamPlaybackResampled | MISSING | MISSING | 0/0 | 0% | | AudioStreamPlayer | OK | OK | 15/17 | 95% | | AudioStreamPlayer2D | OK | OK | 14/16 | 94% | | AudioStreamPlayer3D | OK | OK | 32/34 | 96% | | BakedLightmap | OK | OK | 13/22 | 79% | | BakedLightmapData | MISSING | MISSING | 0/10 | 0% | | BaseButton | OK | OK | 24/25 | 98% | | Basis | OK | OK | 22/24 | 95% | | BitMap | OK | OK | 7/9 | 93% | | BulletPhysicsDirectBodyState | MISSING | MISSING | 0/0 | 0% | | BulletPhysicsServer | MISSING | MISSING | 0/0 | 0% | | CPUParticles | OK | OK | 86/89 | 97% | | CPUParticles2D | OK | OK | 83/87 | 96% | | CSGMesh | OK | OK | 1/2 | 95% | | CSGPrimitive | OK | MISSING | 1/1 | 52% | | CSGShape | OK | OK | 13/15 | 94% | | CSharpScript | MISSING | MISSING | 0/1 | 0% | | Camera | OK | OK | 32/37 | 91% | | Camera2D | OK | OK | 33/36 | 95% | | CameraFeed | OK | OK | 10/12 | 94% | | CameraServer | OK | MISSING | 11/11 | 68% | | CameraTexture | OK | MISSING | 3/3 | 57% | | CanvasItem | OK | OK | 65/68 | 97% | | CanvasItemMaterial | OK | OK | 10/14 | 88% | | CanvasLayer | OK | OK | 8/10 | 93% | | ClippedCamera | MISSING | MISSING | 0/15 | 0% | | CollisionObject2D | OK | OK | 23/25 | 96% | | CollisionPolygon2D | OK | OK | 6/7 | 96% | | CollisionShape2D | OK | OK | 3/4 | 96% | | Color | OK | OK | 30/176 | 26% | | ColorPicker | OK | OK | 11/13 | 94% | | ColorPickerButton | OK | OK | 5/6 | 96% | | ConfigFile | OK | OK | 9/13 | 88% | | Control | OK | OK | 132/167 | 81% | | DynamicFont | OK | OK | 17/19 | 95% | | 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 | 18/21 | 93% | | EditorNavigationMeshGenerator | MISSING | MISSING | 0/2 | 0% | | EditorPlugin | OK | OK | 37/78 | 58% | | EditorResourceConversionPlugin | MISSING | MISSING | 0/2 | 0% | | EditorSceneImporter | MISSING | MISSING | 0/16 | 0% | | EditorSettings | OK | OK | 8/17 | 76% | | EditorSpatialGizmo | OK | OK | 12/17 | 86% | | EditorSpatialGizmoPlugin | OK | OK | 16/17 | 97% | | Engine | OK | OK | 14/17 | 92% | | Environment | OK | OK | 82/110 | 78% | | Font | OK | OK | 7/10 | 90% | | FuncRef | OK | OK | 3/4 | 96% | | GDNative | MISSING | MISSING | 0/4 | 0% | | GDNativeLibrary | MISSING | MISSING | 0/7 | 0% | | GDScriptFunctionState | OK | OK | 2/3 | 96% | | GDScriptNativeClass | MISSING | MISSING | 0/1 | 0% | | GIProbe | MISSING | MISSING | 1/17 | 3% | | GIProbeData | MISSING | MISSING | 0/11 | 0% | | Generic6DOFJoint | OK | OK | 82/109 | 79% | | Geometry | MISSING | MISSING | 46/47 | 69% | | GodotSharp | MISSING | MISSING | 4/8 | 14% | | GraphEdit | OK | OK | 28/31 | 94% | | GraphNode | OK | OK | 21/32 | 79% | | GridMap | OK | OK | 14/29 | 69% | | HTTPRequest | OK | OK | 21/22 | 98% | | HingeJoint | OK | OK | 20/22 | 95% | | Image | OK | OK | 90/107 | 87% | | Input | OK | OK | 59/61 | 98% | | InputEvent | OK | OK | 8/12 | 88% | | InputEventGesture | MISSING | MISSING | 0/1 | 0% | | InputEventMIDI | MISSING | MISSING | 0/8 | 0% | | InputEventMagnifyGesture | MISSING | MISSING | 0/1 | 0% | | InputEventPanGesture | MISSING | MISSING | 0/1 | 0% | | InputMap | OK | OK | 11/12 | 97% | | InstancePlaceholder | OK | OK | 2/4 | 92% | | ItemList | OK | OK | 54/61 | 91% | | Light | OK | OK | 16/32 | 69% | | LinkButton | OK | OK | 3/5 | 92% | | Listener | MISSING | MISSING | 0/4 | 0% | | Material | OK | OK | 2/4 | 92% | | MenuButton | OK | OK | 3/4 | 96% | | Mesh | OK | OK | 27/52 | 65% | | MeshInstance2D | OK | OK | 3/4 | 96% | | MeshLibrary | OK | OK | 9/18 | 76% | | MultiMeshInstance2D | OK | OK | 3/4 | 96% | | MultiplayerPeerGDNative | MISSING | MISSING | 0/0 | 0% | | NativeScript | MISSING | MISSING | 5/9 | 17% | | NavigationMesh | MISSING | MISSING | 0/34 | 0% | | NavigationMeshInstance | MISSING | MISSING | 0/2 | 0% | | NavigationPolygonInstance | MISSING | MISSING | 0/2 | 0% | | Nil | MISSING | MISSING | 0/26 | 0% | | NoiseTexture | OK | OK | 5/6 | 96% | | OS | OK | OK | 147/150 | 98% | | OmniLight | OK | OK | 6/8 | 93% | | OptionButton | OK | OK | 16/24 | 82% | | PCKPacker | MISSING | MISSING | 0/3 | 0% | | PackedDataContainer | MISSING | MISSING | 0/3 | 0% | | PackedDataContainerRef | MISSING | MISSING | 0/1 | 0% | | PacketPeerGDNative | MISSING | MISSING | 0/0 | 0% | | PacketPeerStream | OK | OK | 1/3 | 91% | | PhysicalBone | MISSING | MISSING | 0/18 | 0% | | Physics2DDirectSpaceState | OK | OK | 6/7 | 96% | | Physics2DServer | OK | OK | 143/166 | 88% | | Physics2DShapeQueryParameters | OK | OK | 7/9 | 93% | | Physics2DShapeQueryResult | MISSING | MISSING | 0/5 | 0% | | Physics2DTestMotionResult | MISSING | MISSING | 0/9 | 0% | | PhysicsDirectBodyState | OK | OK | 29/31 | 96% | | PhysicsMaterial | OK | OK | 2/4 | 92% | | PhysicsServer | OK | OK | 217/238 | 92% | | PhysicsShapeQueryParameters | MISSING | MISSING | 0/8 | 0% | | PhysicsShapeQueryResult | OK | MISSING | 0/5 | 40% | | Plane | OK | OK | 13/21 | 80% | | PlaneShape | MISSING | MISSING | 0/1 | 0% | | PluginScript | MISSING | MISSING | 1/1 | 5% | | Polygon2D | OK | OK | 13/25 | 73% | | PolygonPathFinder | MISSING | MISSING | 0/8 | 0% | | PopupMenu | OK | OK | 55/57 | 97% | | ProceduralSky | OK | OK | 17/22 | 88% | | ProjectSettings | OK | OK | 157/283 | 58% | | ProximityGroup | OK | OK | 0/7 | 74% | | ProxyTexture | MISSING | MISSING | 0/1 | 0% | | Quat | OK | OK | 21/22 | 98% | | ReflectionProbe | MISSING | MISSING | 0/14 | 0% | | ResourceImporter | MISSING | MISSING | 0/0 | 0% | | RichTextLabel | OK | OK | 39/59 | 75% | | RigidBody | OK | OK | 40/41 | 98% | | RigidBody2D | OK | OK | 41/42 | 98% | | RootMotionView | MISSING | MISSING | 0/5 | 0% | | ScriptEditor | MISSING | MISSING | 5/9 | 17% | | ScrollBar | OK | OK | 1/2 | 95% | | ScrollContainer | OK | OK | 6/9 | 90% | | Shader | OK | OK | 1/8 | 75% | | ShaderMaterial | OK | OK | 3/5 | 92% | | Shape | OK | OK | 0/1 | 95% | | Shape2D | OK | OK | 4/5 | 96% | | Skeleton | OK | OK | 17/30 | 74% | | Skeleton2D | MISSING | MISSING | 0/4 | 0% | | SkeletonIK | MISSING | MISSING | 0/14 | 0% | | Slider | OK | OK | 4/5 | 96% | | SoftBody | OK | OK | 10/21 | 73% | | Spatial | OK | OK | 41/46 | 92% | | SpatialGizmo | MISSING | MISSING | 0/0 | 0% | | SpatialMaterial | OK | OK | 71/189 | 44% | | SpatialVelocityTracker | MISSING | MISSING | 0/4 | 0% | | SplitContainer | OK | OK | 5/8 | 89% | | SpringArm | MISSING | MISSING | 0/8 | 0% | | SpriteBase3D | OK | OK | 15/21 | 85% | | SpriteFrames | OK | OK | 16/17 | 97% | | StaticBody | OK | OK | 4/5 | 96% | | StaticBody2D | OK | OK | 4/5 | 96% | | StreamPeerBuffer | MISSING | MISSING | 0/7 | 0% | | StreamPeerGDNative | MISSING | MISSING | 0/0 | 0% | | StreamPeerSSL | OK | OK | 7/11 | 87% | | String | OK | OK | 96/98 | 98% | | StyleBox | OK | OK | 8/11 | 90% | | StyleBoxFlat | OK | OK | 22/28 | 88% | | StyleBoxLine | MISSING | MISSING | 0/5 | 0% | | StyleBoxTexture | OK | OK | 12/21 | 78% | | SurfaceTool | OK | OK | 21/23 | 95% | | Tabs | OK | OK | 24/37 | 77% | | TextEdit | OK | OK | 76/80 | 96% | | TextFile | MISSING | MISSING | 0/0 | 0% | | Texture | OK | OK | 12/17 | 86% | | Texture3D | MISSING | MISSING | 0/0 | 0% | | TextureArray | MISSING | MISSING | 0/0 | 0% | | TextureLayered | MISSING | MISSING | 0/14 | 0% | | Theme | OK | OK | 29/31 | 96% | | Thread | OK | OK | 4/7 | 89% | | TileMap | OK | OK | 48/51 | 96% | | TileSet | OK | OK | 63/82 | 81% | | Transform | OK | OK | 17/21 | 90% | | Transform2D | OK | OK | 20/23 | 93% | | Tree | OK | OK | 45/52 | 90% | | TreeItem | OK | OK | 55/65 | 88% | | VScrollBar | OK | MISSING | 0/0 | 50% | | VehicleWheel | OK | OK | 13/14 | 97% | | VideoPlayer | OK | OK | 15/16 | 97% | | VideoStream | OK | MISSING | 0/0 | 50% | | VideoStreamGDNative | MISSING | MISSING | 0/2 | 0% | | VideoStreamTheora | MISSING | MISSING | 0/2 | 0% | | VideoStreamWebm | MISSING | MISSING | 0/2 | 0% | | Viewport | OK | OK | 68/90 | 80% | | ViewportContainer | OK | OK | 1/2 | 95% | | VisibilityEnabler2D | OK | OK | 12/13 | 97% | | VisualInstance | MISSING | MISSING | 4/8 | 14% | | VisualScriptBuiltinFunc | OK | OK | 63/67 | 95% | | 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% | | 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% | | VisualServer | OK | OK | 281/575 | 51% | | VisualShader | MISSING | MISSING | 1/22 | 2% | | VisualShaderNode | MISSING | MISSING | 0/5 | 0% | | VisualShaderNodeBooleanConstant | MISSING | MISSING | 0/1 | 0% | | VisualShaderNodeBooleanUniform | MISSING | MISSING | 0/0 | 0% | | VisualShaderNodeColorConstant | MISSING | MISSING | 0/1 | 0% | | VisualShaderNodeColorFunc | MISSING | MISSING | 0/3 | 0% | | VisualShaderNodeColorOp | MISSING | MISSING | 0/10 | 0% | | VisualShaderNodeColorUniform | MISSING | MISSING | 0/0 | 0% | | VisualShaderNodeCubeMap | MISSING | MISSING | 0/5 | 0% | | VisualShaderNodeCubeMapUniform | MISSING | MISSING | 0/0 | 0% | | VisualShaderNodeDeterminant | MISSING | MISSING | 0/0 | 0% | | VisualShaderNodeDotProduct | MISSING | MISSING | 0/0 | 0% | | VisualShaderNodeExpression | MISSING | MISSING | 0/2 | 0% | | VisualShaderNodeFaceForward | MISSING | MISSING | 0/0 | 0% | | VisualShaderNodeFresnel | MISSING | MISSING | 0/0 | 0% | | VisualShaderNodeGroupBase | MISSING | MISSING | 0/25 | 0% | | VisualShaderNodeIf | MISSING | MISSING | 0/0 | 0% | | VisualShaderNodeInput | MISSING | MISSING | 0/2 | 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% | | VisualShaderNodeScalarUniform | MISSING | MISSING | 0/0 | 0% | | VisualShaderNodeSwitch | MISSING | MISSING | 0/0 | 0% | | VisualShaderNodeTexture | MISSING | MISSING | 0/10 | 0% | | VisualShaderNodeTextureUniform | MISSING | MISSING | 0/8 | 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% | | 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% | | -------------------------------------- | ----------- | ------- | --------- | ------- | | Total = 301 | MISSING | MISSING | 7677/9927 | 77% | | -------------------------------------- | ----------- | ------- | --------- | ------- |