Inheritance #
- AudioServer
- CameraServer
- ClassDB
- DisplayServer
- EditorFileSystemDirectory
- EditorInterface
- EditorPaths
- EditorSelection
- EditorUndoRedoManager
- EditorVCSInterface
- Engine
- EngineDebugger
- FramebufferCacheRD
- GDExtensionManager
- Geometry2D
- Geometry3D
- IP
- Input
- InputMap
- JNISingleton
- JSONRPC
- JavaClassWrapper
- JavaScriptBridge
- MainLoop (1)
- Marshalls
- MovieWriter
- NativeMenu
- NavigationMeshGenerator
- NavigationServer2D
- NavigationServer3D
- Node (21)
- OS
- OpenXRExtensionWrapperExtension
- OpenXRInteractionProfileMetadata
- Performance
- PhysicsDirectBodyState2D (1)
- PhysicsDirectBodyState3D (1)
- PhysicsDirectSpaceState2D (1)
- PhysicsDirectSpaceState3D (1)
- PhysicsServer2D (1)
- PhysicsServer2DManager
- PhysicsServer3D (1)
- PhysicsServer3DManager
- PhysicsServer3DRendering
ServerHandler
- ProjectSettings
- RefCounted (121)
- RenderData (2)
- RenderSceneData (2)
- RenderingDevice
- RenderingServer
- ResourceLoader
- ResourceSaver
- ResourceUID
- ScriptLanguage (1)
- ShaderIncludeDB
- TextServerManager
- ThemeDB
- TileData
- Time
- TranslationServer
- TreeItem
- UndoRedo
- UniformSetCacheRD
- WorkerThreadPool
- XRServer
- XRVRS
- AESContext
- AStar2D
- AStar3D
- AStarGrid2D
- AudioEffectInstance (1)
- AudioSample
- AudioSamplePlayback
- AudioStreamPlayback (5)
- CameraFeed
- CharFXTransform
- ConfigFile
- Crypto
- DTLSServer
- DirAccess
- ENetConnection
- EditorContextMenuPlugin
- EditorDebuggerPlugin
- EditorDebuggerSession
- EditorExportPlatform (6)
- EditorExportPlugin
- EditorExportPreset
- EditorFeatureProfile
- EditorFileSystemImportFormatSupportQuery
- EditorInspectorPlugin
- EditorResourceConversionPlugin
- EditorResourcePreviewGenerator
- EditorResourceTooltipPlugin
- EditorSceneFormatImporter (4)
- EditorScenePostImport
- EditorScenePostImportPlugin
- EditorScript
- EditorTranslationParserPlugin
- EncodedObjectAsID
- EngineProfiler
- Expression
- FileAccess
- GLTFObjectModelProperty
- HMACContext
- HTTPClient
- HashingContext
- ImageFormatLoader (1)
- JavaClass
- JavaObject
- JavaScriptObject
- KinematicCollision2D
- KinematicCollision3D
- Lightmapper (1)
- MeshConvexDecompositionSettings
- MeshDataTool
- MultiplayerAPI (2)
- Mutex
- NavigationPathQueryParameters2D
- NavigationPathQueryParameters3D
- NavigationPathQueryResult2D
- NavigationPathQueryResult3D
- Node3DGizmo (1)
- OggPacketSequencePlayback
- OpenXRAPIExtension
- PCKPacker
- PackedDataContainerRef
- PacketPeer (8)
- PhysicsPointQueryParameters2D
- PhysicsPointQueryParameters3D
- PhysicsRayQueryParameters2D
- PhysicsRayQueryParameters3D
- PhysicsShapeQueryParameters2D
- PhysicsShapeQueryParameters3D
- PhysicsTestMotionParameters2D
- PhysicsTestMotionParameters3D
- PhysicsTestMotionResult2D
- PhysicsTestMotionResult3D
- RDAttachmentFormat
- RDFramebufferPass
- RDPipelineColorBlendState
- RDPipelineColorBlendStateAttachment
- RDPipelineDepthStencilState
- RDPipelineMultisampleState
- RDPipelineRasterizationState
- RDPipelineSpecializationConstant
- RDSamplerState
- RDShaderSource
- RDTextureFormat
- RDTextureView
- RDUniform
- RDVertexAttribute
- RandomNumberGenerator
- RegEx
- RegExMatch
- RenderSceneBuffers (2)
- RenderSceneBuffersConfiguration
- Resource (103)
- ResourceFormatLoader
- ResourceFormatSaver
- ResourceImporter (16)
- SceneState
- SceneTreeTimer
- Semaphore
- SkinReference
- StreamPeer (5)
- SurfaceTool
- TCPServer
- TLSOptions
- TextLine
- TextParagraph
- TextServer (1)
- Thread
- TranslationDomain
- TriangleMesh
- Tween
- Tweener (5)
- UDPServer
- UPNP
- UPNPDevice
- WeakRef
- WebRTCPeerConnection (1)
- XMLParser
- XRInterface (4)
- XRPose
- XRTracker (2)
- ZIPPacker
- ZIPReader
- Animation
- AnimationLibrary
- AnimationNode (6)
- AnimationNodeStateMachinePlayback
- AnimationNodeStateMachineTransition
- AudioBusLayout
- AudioEffect (17)
- AudioStream (10)
- BitMap
- BoneMap
- ButtonGroup
- CameraAttributes (2)
- ColorPalette
- Compositor
- CompositorEffect
- CryptoKey
- Curve
- Curve2D
- Curve3D
- EditorNode3DGizmoPlugin
- EditorSettings
- Environment
- Font (3)
- GDExtension
- GLTFAccessor
- GLTFAnimation
- GLTFBufferView
- GLTFCamera
- GLTFDocument (1)
- GLTFDocumentExtension (1)
- GLTFLight
- GLTFMesh
- GLTFNode
- GLTFPhysicsBody
- GLTFPhysicsShape
- GLTFSkeleton
- GLTFSkin
- GLTFSpecGloss
- GLTFState (1)
- GLTFTexture
- GLTFTextureSampler
- Gradient
- Image
- ImporterMesh
- InputEvent (6)
- JSON
- LabelSettings
- LightmapGIData
- Material (9)
- Mesh (4)
- MeshLibrary
- MissingResource
- MultiMesh
- NavigationMesh
- NavigationMeshSourceGeometryData2D
- NavigationMeshSourceGeometryData3D
- NavigationPolygon
- Noise (1)
- Occluder3D (5)
- OccluderPolygon2D
- OggPacketSequence
- OpenXRAction
- OpenXRActionMap
- OpenXRActionSet
- OpenXRBindingModifier (2)
- OpenXRHapticBase (1)
- OpenXRIPBinding
- OpenXRInteractionProfile
- PackedDataContainer
- PackedScene
- PhysicsMaterial
- PolygonPathFinder
- RDShaderFile
- RDShaderSPIRV
- RichTextEffect
- SceneReplicationConfig
- Script (3)
- Shader (1)
- ShaderInclude
- Shape2D (8)
- Shape3D (9)
- Shortcut
- SkeletonModification2D (7)
- SkeletonModificationStack2D
- SkeletonProfile (1)
- Skin
- Sky
- SpriteFrames
- StyleBox (4)
- SyntaxHighlighter (2)
- Texture (3)
- Theme
- TileMapPattern
- TileSet
- TileSetSource (2)
- Translation (1)
- VideoStream (1)
- VideoStreamPlayback
- VisualShaderNode (62)
- VoxelGIData
- World2D
- World3D
- X509Certificate
Table of contents
-
func clear() -> void -
func create_item(id: int) -> void -
const func find_item_by_name(name: String) -> int -
const func get_item_list() -> PackedInt32Array -
const func get_item_mesh(id: int) -> Mesh -
const func get_item_mesh_cast_shadow(id: int) -> intRenderingServer.ShadowCastingSetting -
const func get_item_mesh_transform(id: int) -> Transform3D -
const func get_item_name(id: int) -> String -
const func get_item_navigation_layers(id: int) -> int -
const func get_item_navigation_mesh(id: int) -> NavigationMesh -
const func get_item_navigation_mesh_transform(id: int) -> Transform3D -
const func get_item_preview(id: int) -> Texture2D -
const func get_item_shapes(id: int) -> Array -
const func get_last_unused_item_id() -> int -
func remove_item(id: int) -> void -
func set_item_mesh(mesh: Mesh) -> void -
func set_item_mesh_cast_shadow(shadow_casting_setting: int enumRenderingServer.ShadowCastingSetting) -> void -
func set_item_mesh_transform(mesh_transform: Transform3D) -> void -
func set_item_name(name: String) -> void -
func set_item_navigation_layers(navigation_layers: int) -> void -
func set_item_navigation_mesh(navigation_mesh: NavigationMesh) -> void -
func set_item_navigation_mesh_transform(navigation_mesh: Transform3D) -> void -
func set_item_preview(texture: Texture2D) -> void -
func set_item_shapes(shapes: Array) -> void
MeshLibrary #
is_refcounted, is_instantiable, resource, core, not_builtin_classes
Library of meshes.
A library of meshes. Contains a list of Mesh resources, each with a name and ID. Each item can also include collision and navigation shapes. This resource is used in GridMap.
Members #
Methods #
func clear() -> void#
Clears the library.
func create_item(id: int) -> void#
Creates a new item in the library with the given ID.
You can get an unused ID from get_last_unused_item_id.
const func find_item_by_name(name: String) -> int#
Returns the first item with the given name, or -1 if no item is found.
const func get_item_list() -> PackedInt32Array#
Returns the list of item IDs in use.
const func get_item_mesh(id: int) -> Mesh#
Returns the item's mesh.
const func get_item_mesh_cast_shadow(id: int) -> intRenderingServer.ShadowCastingSetting#
Returns the item's shadow casting mode. See RenderingServer.ShadowCastingSetting for possible values.
const func get_item_mesh_transform(id: int) -> Transform3D#
Returns the transform applied to the item's mesh.
const func get_item_name(id: int) -> String#
Returns the item's name.
const func get_item_navigation_layers(id: int) -> int#
Returns the item's navigation layers bitmask.
const func get_item_navigation_mesh(id: int) -> NavigationMesh#
Returns the item's navigation mesh.
const func get_item_navigation_mesh_transform(id: int) -> Transform3D#
Returns the transform applied to the item's navigation mesh.
const func get_item_preview(id: int) -> Texture2D#
When running in the editor, returns a generated item preview (a 3D rendering in isometric perspective). When used in a running project, returns the manually-defined item preview which can be set using set_item_preview. Returns an empty Texture2D if no preview was manually set in a running project.
const func get_item_shapes(id: int) -> Array#
Returns an item's collision shapes.
The array consists of each Shape3D followed by its Transform3D.
const func get_last_unused_item_id() -> int#
Gets an unused ID for a new item.
func remove_item(id: int) -> void#
Removes the item.
func set_item_mesh(mesh: Mesh) -> void#
Sets the item's mesh.
func set_item_mesh_cast_shadow(shadow_casting_setting: int enumRenderingServer.ShadowCastingSetting) -> void#
Sets the item's shadow casting mode. See RenderingServer.ShadowCastingSetting for possible values.
func set_item_mesh_transform(mesh_transform: Transform3D) -> void#
Sets the transform to apply to the item's mesh.
func set_item_name(name: String) -> void#
Sets the item's name.
This name is shown in the editor. It can also be used to look up the item later using find_item_by_name.
func set_item_navigation_layers(navigation_layers: int) -> void#
Sets the item's navigation layers bitmask.
func set_item_navigation_mesh(navigation_mesh: NavigationMesh) -> void#
Sets the item's navigation mesh.
func set_item_navigation_mesh_transform(navigation_mesh: Transform3D) -> void#
Sets the transform to apply to the item's navigation mesh.
func set_item_preview(texture: Texture2D) -> void#
Sets a texture to use as the item's preview icon in the editor.
func set_item_shapes(shapes: Array) -> void#
Sets an item's collision shapes.
The array should consist of Shape3D objects, each followed by a Transform3D that will be applied to it. For shapes that should not have a transform, use Transform3D.IDENTITY.