GDScript 내보내기(Export)

내보내기 소개

Godot에서 클래스 멤버는 내보낼 수 있습니다. 즉, 멤버의 값은 (처럼) 붙어있는 리소스와 함께 저장됩니다. 그리고 속성(Property) 편집기에서 편집할 수 있습니다. 내보내려면 export 키워드를 사용합니다:

extends Button

export var number = 5 # Value will be saved and visible in the property editor.

내보낸 변수는 상수 표현식으로 초기화되거나 export 키워드에 대한 인수 형식의 내보내기 힌트가 있어야 합니다(아래 예제 섹션을 참고하세요).

멤버 변수 내보내기의 기본적인 장점 중 하나는 에디터에서 멤버 변수를 보고 편집할 수 있다는 점입니다. 이런 식으로 아티스트와 게임 디자이너는 나중에 프로그램 실행 방식에 영향을 주는 값을 수정할 수 있습니다. 이를 위해 특별한 내보내기 구문이 제공됩니다.

참고

Exporting properties can also be done in other languages such as C#. The syntax varies depending on the language.

예제

# If the exported value assigns a constant or constant expression,
# the type will be inferred and used in the editor.

export var number = 5

# Export can take a basic data type as an argument, which will be
# used in the editor.

export(int) var number

# Export can also take a resource type to use as a hint.

export(Texture) var character_face
export(PackedScene) var scene_file
# There are many resource types that can be used this way, try e.g.
# the following to list them:
export(Resource) var resource

# Integers and strings hint enumerated values.

# Editor will enumerate as 0, 1 and 2.
export(int, "Warrior", "Magician", "Thief") var character_class
# Editor will enumerate with string names.
export(String, "Rebecca", "Mary", "Leah") var character_name

# Named enum values

# Editor will enumerate as THING_1, THING_2, ANOTHER_THING.
enum NamedEnum {THING_1, THING_2, ANOTHER_THING = -1}
export(NamedEnum) var x

# Strings as paths

# String is a path to a file.
export(String, FILE) var f
# String is a path to a directory.
export(String, DIR) var f
# String is a path to a file, custom filter provided as hint.
export(String, FILE, "*.txt") var f

# Using paths in the global filesystem is also possible,
# but only in scripts in "tool" mode.

# String is a path to a PNG file in the global filesystem.
export(String, FILE, GLOBAL, "*.png") var tool_image
# String is a path to a directory in the global filesystem.
export(String, DIR, GLOBAL) var tool_dir

# The MULTILINE setting tells the editor to show a large input
# field for editing over multiple lines.
export(String, MULTILINE) var text

# Limiting editor input ranges

# Allow integer values from 0 to 20.
export(int, 20) var i
# Allow integer values from -10 to 20.
export(int, -10, 20) var j
# Allow floats from -10 to 20 and snap the value to multiples of 0.2.
export(float, -10, 20, 0.2) var k
# Allow values 'y = exp(x)' where 'y' varies between 100 and 1000
# while snapping to steps of 20. The editor will present a
# slider for easily editing the value.
export(float, EXP, 100, 1000, 20) var l

# Floats with easing hint

# Display a visual representation of the 'ease()' function
# when editing.
export(float, EASE) var transition_speed

# Colors

# Color given as red-green-blue value (alpha will always be 1).
export(Color, RGB) var col
# Color given as red-green-blue-alpha value.
export(Color, RGBA) var col

# Nodes

# Another node in the scene can be exported as a NodePath.
export(NodePath) var node_path
# Do take note that the node itself isn't being exported -
# there is one more step to call the true node:
onready var node = get_node(node_path)

# Resources

export(Resource) var resource
# In the Inspector, you can then drag and drop a resource file
# from the FileSystem dock into the variable slot.

# Opening the inspector dropdown may result in an
# extremely long list of possible classes to create, however.
# Therefore, if you specify an extension of Resource such as:
export(AnimationNode) var resource
# The drop-down menu will be limited to AnimationNode and all
# its inherited classes.

에디터에서 스크립트가 실행되지 않더라도 내보낸 속성은 계속 편집할 수 있습니다. 속성은 "툴(Tool)" 모드의 스크립트와 함께 사용할 수 있습니다.

비트 플래그(bit flags) 내보내기

비트 플래그로 사용되는 정수는 하나의 속성에 여러 true/false(불리언) 값을 저장할 수 있습니다. 다음과 같이 내보내기 힌트 int, FLAGS, ...를 사용해 에디터에서 설정할 수 있습니다:

# Set any of the given flags from the editor.
export(int, FLAGS, "Fire", "Water", "Earth", "Wind") var spell_elements = 0

각 플래그에 대한 문자열 설명을 제공해야 합니다. 이 예제에서 Fire는 값 1, Water는 값 2, Earth는 값 4, Wind는 값 8에 해당합니다. 일반적으로 상수는 이에 따라 정의되어야 합니다(예: const ELEMENT_WIND = 8 등등).

프로젝트 설정에 정의된 물리 및 렌더 레이어에 대한 내보내기 힌트도 제공됩니다:

export(int, LAYERS_2D_PHYSICS) var layers_2d_physics
export(int, LAYERS_2D_RENDER) var layers_2d_render
export(int, LAYERS_3D_PHYSICS) var layers_3d_physics
export(int, LAYERS_3D_RENDER) var layers_3d_render

비트 플래그를 사용하려면 비트 연산에 대한 이해가 필요합니다. 확실하지 않은 경우 대신 boolean 변수를 사용하세요.

배열 내보내기

내보낸 배열에 초기화 변수를 할당할 수 있지만 상수 표현식이어야 합니다.

내보낸 배열이 Resource를 상속받는 타입을 지정하는 경우 파일시스템(FileSystem) 독에서 여러 파일을 한 번에 끌어다 놓으면 인스펙터(Inspector)에서 배열 값을 설정할 수 있습니다.

# Default value must be a constant expression.

export var a = [1, 2, 3]

# Exported arrays can specify type (using the same hints as before).

export(Array, int) var ints = [1, 2, 3]
export(Array, int, "Red", "Green", "Blue") var enums = [2, 1, 0]
export(Array, Array, float) var two_dimensional = [[1.0, 2.0], [3.0, 4.0]]

# You can omit the default value, but then it would be null if not assigned.

export(Array) var b
export(Array, PackedScene) var scenes

# Arrays with specified types which inherit from resource can be set by
# drag-and-dropping multiple files from the FileSystem dock.

export(Array, Texture) var textures
export(Array, PackedScene) var scenes

# Typed arrays also work, only initialized empty:

export var vector3s = PoolVector3Array()
export var strings = PoolStringArray()

# Default value can include run-time values, but can't
# be exported.

var c = [a, 2, 3]

툴 스크립트에서 내보낸 변수 설정

툴 모드(Tool mode) 스크립트에서 내보낸 변수의 값을 변경할 때 인스펙터(Inspector)의 값은 자동으로 업데이트되지 않습니다. 업데이트하려면 내보낸 변수의 값을 설정한 후 property_list_changed_notify()를 호출하세요.

고급 내보내기

불필요한 디자인 복잡성을 피하기 위해 모든 타입의 내보내기를 언어 자체 수준에서 제공할 수 있는 것은 아닙니다. 다음은 로우 레벨 API로 구현할 수 있는 다소 일반적인 내보내기 기능에 대해 설명합니다.

더 읽기 전에 속성이 처리되는 방식과 doc_accessing_data_or_logic_from_object`에 설명된 대로 :ref:`_set(), _get(), _get_property_list() 메서드를 동해 속성을 커스텀하는 방법에 대해 알고 있어야 합니다.

더 보기

C++에서 위의 방법을 사용해 속성을 바인딩하려면 Binding properties using _set/_get/_get_property_list를 참고하세요.

경고

위의 방법이 에디터 안에서 작동할 수 있도록 스크립트는 툴(tool) 모드에서 작동해야 합니다.

Properties

To understand how to better use the sections below, you should understand how to make properties with advanced exports.

func _get_property_list():
    var properties = []
    # Same as "export(int) var my_property"
    properties.append({
        name = "my_property",
        type = TYPE_INT
    })
    return properties
  • The _get_property_list() function gets called by the inspector. You can override it for more advanced exports. You must return an Array with the contents of the properties for the function to work.

  • name is the name of the property

  • type is the type of the property from Variant.Type.

참고

The float type is called a real (TYPE_REAL) in the Variant.Type enum.

Attaching variables to properties

To attach variables to properties (allowing the value of the property to be used in scripts), you need to create a variable with the exact same name as the property or else you may need to override the _set() and _get() methods. Attaching a variable to to a property also gives you the ability to give it a default state.

# This variable is determined by the function below.
# This variable acts just like a regular gdscript export.
var my_property = 5

func _get_property_list():
    var properties = []
    # Same as "export(int) var my_property"
    properties.append({
        name = "my_property",
        type = TYPE_INT
    })
    return properties

Adding default values for properties

To define default values for advanced exports, you need to override the property_can_revert() and property_get_revert() methods.

  • The property_can_revert() method takes the name of a property and must return true if the property can be reverted. This will enable the Revert button next to the property in the inspector.

  • The property_get_revert() method takes the name of a property and must return the default value for that property.

func _get_property_list():
    var properties = []
    properties.append({
        name = "my_property",
        type = TYPE_INT
    })
    return properties

func property_can_revert(property):
    if property == "my_property":
        return true
    return false

func property_get_revert(property):
    if property == "my_property":
        return 5

스크립트 카테고리 추가

For better visual distinguishing of properties, a special script category can be embedded into the inspector to act as a separator. Script Variables is one example of a built-in category.

func _get_property_list():
    var properties = []
    properties.append({
        name = "Debug",
        type = TYPE_NIL,
        usage = PROPERTY_USAGE_CATEGORY | PROPERTY_USAGE_SCRIPT_VARIABLE
    })

    # Example of adding a property to the script category
    properties.append({
        name = "Logging_Enabled",
        type = TYPE_BOOL
    })
    return properties
  • name은 인스펙터(Inspector)에 추가할 카테고리의 이름입니다.

  • Every following property added after the category definition will be a part of the category.

  • PROPERTY_USAGE_CATEGORY는 속성을 스크립트 카테고리로 구체적으로 처리해야 함을 명시하므로 실제로 스크립팅 로직에 사용되지 않는 TYPE_NIL 타입은 무시할 수 있지만 어쨌든 정의해야 합니다.

속성 그루핑(Grouping)

A list of properties with similar names can be grouped.

func _get_property_list():
    var properties = []
    properties.append({
        name = "Rotate",
        type = TYPE_NIL,
        hint_string = "rotate_",
        usage = PROPERTY_USAGE_GROUP | PROPERTY_USAGE_SCRIPT_VARIABLE
    })

    # Example of adding to the group
    properties.append({
        name = "rotate_speed",
        type = TYPE_REAL
    })

    # This property won't get added to the group
    # due to not having the "rotate_" prefix.
    properties.append({
        name = "trail_color",
        type = TYPE_COLOR
    })
    return properties
  • name은 축소 가능한 속성 목록으로 표시될 그룹의 이름입니다.

  • Every following property added after the group property with the prefix (which determined by hint_string) will be shortened. For instance, rotate_speed is going to be shortened to speed in this case. However, movement_speed won't be a part of the group and will not be shortened.

  • PROPERTY_USAGE_GROUP은 속성이 특히 스크립트 그룹으로 처리되어야 함을 나타냅니다. 따라서 TYPE_NIL 타입은 실제로 스크립팅 로직에 사용되지 않기 때문에 무시할 수 있지만 어쨌든 정의해야 합니다.