Index · Object → RefCounted → Resource → MeshLibrary

MeshLibrary

Library of meshes.

Class Description

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.

Properties

Inherited from Resource (4)

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().

func find_item_by_name(name: String) -> int

Returns the first item with the given name, or -1 if no item is found.

func get_item_count() -> int

Returns the number of items present in the library.

func get_item_list() -> PackedInt32Array

Returns the list of item IDs in use.

func get_item_mesh(id: int) -> Mesh

Returns the item's mesh.

func get_item_mesh_cast_shadow(id: int) -> RenderingServer.ShadowCastingSetting

Returns the item's shadow casting mode.

func get_item_mesh_transform(id: int) -> Transform3D

Returns the transform applied to the item's mesh.

func get_item_name(id: int) -> String

Returns the item's name.

func get_item_navigation_layers(id: int) -> int

Returns the item's navigation layers bitmask.

func get_item_navigation_mesh(id: int) -> NavigationMesh

Returns the item's navigation mesh.

func get_item_navigation_mesh_transform(id: int) -> Transform3D

Returns the transform applied to the item's navigation mesh.

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.

func get_item_shapes(id: int) -> Array

Returns an item's collision shapes.

The array consists of each Shape3D followed by its Transform3D.

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(id: int, mesh: Mesh) -> void

Sets the item's mesh.

func set_item_mesh_cast_shadow(id: int, shadow_casting_setting: RenderingServer.ShadowCastingSetting) -> void

Sets the item's shadow casting mode to shadow_casting_setting.

func set_item_mesh_transform(id: int, mesh_transform: Transform3D) -> void

Sets the transform to apply to the item's mesh.

func set_item_name(id: int, 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(id: int, navigation_layers: int) -> void

Sets the item's navigation layers bitmask.

func set_item_navigation_mesh(id: int, navigation_mesh: NavigationMesh) -> void

Sets the item's navigation mesh.

func set_item_navigation_mesh_transform(id: int, navigation_mesh: Transform3D) -> void

Sets the transform to apply to the item's navigation mesh.

func set_item_preview(id: int, texture: Texture2D) -> void

Sets a texture to use as the item's preview icon in the editor.

func set_item_shapes(id: int, 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.

Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Resource (2)
signal changed()
Inherited from Object (2)