[doc] Use "param" instead of "code" to refer to parameters (7)
This commit is contained in:
@ -27,7 +27,7 @@
|
||||
<param index="0" name="at_position" type="Vector2" />
|
||||
<param index="1" name="data" type="Variant" />
|
||||
<description>
|
||||
Godot calls this method to test if [code]data[/code] from a control's [method _get_drag_data] can be dropped at [code]position[/code]. [code]position[/code] is local to this control.
|
||||
Godot calls this method to test if [param data] from a control's [method _get_drag_data] can be dropped at [param at_position]. [param at_position] is local to this control.
|
||||
This method should only be used to test the data. Process the data in [method _drop_data].
|
||||
[codeblocks]
|
||||
[gdscript]
|
||||
@ -52,7 +52,7 @@
|
||||
<param index="0" name="at_position" type="Vector2" />
|
||||
<param index="1" name="data" type="Variant" />
|
||||
<description>
|
||||
Godot calls this method to pass you the [code]data[/code] from a control's [method _get_drag_data] result. Godot first calls [method _can_drop_data] to test if [code]data[/code] is allowed to drop at [code]position[/code] where [code]position[/code] is local to this control.
|
||||
Godot calls this method to pass you the [param data] from a control's [method _get_drag_data] result. Godot first calls [method _can_drop_data] to test if [param data] is allowed to drop at [param at_position] where [param at_position] is local to this control.
|
||||
[codeblocks]
|
||||
[gdscript]
|
||||
func _can_drop_data(position, data):
|
||||
@ -77,7 +77,7 @@
|
||||
<return type="Variant" />
|
||||
<param index="0" name="at_position" type="Vector2" />
|
||||
<description>
|
||||
Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns [code]null[/code] if there is no data to drag. Controls that want to receive drop data should implement [method _can_drop_data] and [method _drop_data]. [code]position[/code] is local to this control. Drag may be forced with [method force_drag].
|
||||
Godot calls this method to get data that can be dragged and dropped onto controls that expect drop data. Returns [code]null[/code] if there is no data to drag. Controls that want to receive drop data should implement [method _can_drop_data] and [method _drop_data]. [param at_position] is local to this control. Drag may be forced with [method force_drag].
|
||||
A preview that will follow the mouse that should represent the data can be set with [method set_drag_preview]. A good time to set the preview is in this method.
|
||||
[codeblocks]
|
||||
[gdscript]
|
||||
@ -145,7 +145,7 @@
|
||||
<return type="bool" />
|
||||
<param index="0" name="position" type="Vector2" />
|
||||
<description>
|
||||
Virtual method to be implemented by the user. Returns whether the given [code]point[/code] is inside this control.
|
||||
Virtual method to be implemented by the user. Returns whether the given [param position] is inside this control.
|
||||
If not overridden, default behavior is checking if the point is within control's Rect.
|
||||
[b]Note:[/b] If you want to check if a point is inside the control, you can use [code]get_rect().has_point(point)[/code].
|
||||
</description>
|
||||
@ -154,7 +154,7 @@
|
||||
<return type="Object" />
|
||||
<param index="0" name="for_text" type="String" />
|
||||
<description>
|
||||
Virtual method to be implemented by the user. Returns a [Control] node that should be used as a tooltip instead of the default one. The [code]for_text[/code] includes the contents of the [member hint_tooltip] property.
|
||||
Virtual method to be implemented by the user. Returns a [Control] node that should be used as a tooltip instead of the default one. The [param for_text] includes the contents of the [member hint_tooltip] property.
|
||||
The returned node must be of type [Control] or Control-derived. It can have child nodes of any type. It is freed when the tooltip disappears, so make sure you always provide a new instance (if you want to use a pre-existing node from your scene tree, you can duplicate it and pass the duplicated instance). When [code]null[/code] or a non-Control node is returned, the default tooltip will be used instead.
|
||||
The returned node will be added as child to a [PopupPanel], so you should only provide the contents of that panel. That [PopupPanel] can be themed using [method Theme.set_stylebox] for the type [code]"TooltipPanel"[/code] (see [member hint_tooltip] for an example).
|
||||
[b]Note:[/b] The tooltip is shrunk to minimal size. If you want to ensure it's fully visible, you might want to set its [member custom_minimum_size] to some non-zero value.
|
||||
@ -201,7 +201,7 @@
|
||||
<param index="1" name="text" type="String" />
|
||||
<description>
|
||||
User defined BiDi algorithm override function.
|
||||
Returns [code]Array[/code] of [code]Vector2i[/code] text ranges, in the left-to-right order. Ranges should cover full source [code]text[/code] without overlaps. BiDi algorithm will be used on each range separately.
|
||||
Returns [code]Array[/code] of [code]Vector2i[/code] text ranges, in the left-to-right order. Ranges should cover full source [param text] without overlaps. BiDi algorithm will be used on each range separately.
|
||||
</description>
|
||||
</method>
|
||||
<method name="accept_event">
|
||||
@ -215,7 +215,7 @@
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="color" type="Color" />
|
||||
<description>
|
||||
Creates a local override for a theme [Color] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_color_override].
|
||||
Creates a local override for a theme [Color] with the specified [param name]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_color_override].
|
||||
See also [method get_theme_color].
|
||||
[b]Example of overriding a label's color and resetting it later:[/b]
|
||||
[codeblocks]
|
||||
@ -243,7 +243,7 @@
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="constant" type="int" />
|
||||
<description>
|
||||
Creates a local override for a theme constant with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_constant_override].
|
||||
Creates a local override for a theme constant with the specified [param name]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_constant_override].
|
||||
See also [method get_theme_constant].
|
||||
</description>
|
||||
</method>
|
||||
@ -252,7 +252,7 @@
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="font" type="Font" />
|
||||
<description>
|
||||
Creates a local override for a theme [Font] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_font_override].
|
||||
Creates a local override for a theme [Font] with the specified [param name]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_font_override].
|
||||
See also [method get_theme_font].
|
||||
</description>
|
||||
</method>
|
||||
@ -261,7 +261,7 @@
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="font_size" type="int" />
|
||||
<description>
|
||||
Creates a local override for a theme font size with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_font_size_override].
|
||||
Creates a local override for a theme font size with the specified [param name]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_font_size_override].
|
||||
See also [method get_theme_font_size].
|
||||
</description>
|
||||
</method>
|
||||
@ -270,7 +270,7 @@
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="texture" type="Texture2D" />
|
||||
<description>
|
||||
Creates a local override for a theme icon with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_icon_override].
|
||||
Creates a local override for a theme icon with the specified [param name]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_icon_override].
|
||||
See also [method get_theme_icon].
|
||||
</description>
|
||||
</method>
|
||||
@ -279,7 +279,7 @@
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="stylebox" type="StyleBox" />
|
||||
<description>
|
||||
Creates a local override for a theme [StyleBox] with the specified [code]name[/code]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_stylebox_override].
|
||||
Creates a local override for a theme [StyleBox] with the specified [param name]. Local overrides always take precedence when fetching theme items for the control. An override can be removed with [method remove_theme_stylebox_override].
|
||||
See also [method get_theme_stylebox].
|
||||
[b]Example of modifying a property in a StyleBox by duplicating it:[/b]
|
||||
[codeblocks]
|
||||
@ -337,7 +337,7 @@
|
||||
<param index="0" name="data" type="Variant" />
|
||||
<param index="1" name="preview" type="Control" />
|
||||
<description>
|
||||
Forces drag and bypasses [method _get_drag_data] and [method set_drag_preview] by passing [code]data[/code] and [code]preview[/code]. Drag will start even if the mouse is neither over nor pressed on this control.
|
||||
Forces drag and bypasses [method _get_drag_data] and [method set_drag_preview] by passing [param data] and [param preview]. Drag will start even if the mouse is neither over nor pressed on this control.
|
||||
The methods [method _can_drop_data] and [method _drop_data] must be implemented on controls that want to receive drop data.
|
||||
</description>
|
||||
</method>
|
||||
@ -435,7 +435,7 @@
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns a [Color] from the first matching [Theme] in the tree if that [Theme] has a color item with the specified [code]name[/code] and [code]theme_type[/code]. If [code]theme_type[/code] is omitted the class name of the current control is used as the type, or [member theme_type_variation] if it is defined. If the type is a class name its parent classes are also checked, in order of inheritance. If the type is a variation its base types are checked, in order of dependency, then the control's class name and its parent classes are checked.
|
||||
Returns a [Color] from the first matching [Theme] in the tree if that [Theme] has a color item with the specified [param name] and [param theme_type]. If [param theme_type] is omitted the class name of the current control is used as the type, or [member theme_type_variation] if it is defined. If the type is a class name its parent classes are also checked, in order of inheritance. If the type is a variation its base types are checked, in order of dependency, then the control's class name and its parent classes are checked.
|
||||
For the current control its local overrides are considered first (see [method add_theme_color_override]), then its assigned [member theme]. After the current control, each parent control and its assigned [member theme] are considered; controls without a [member theme] assigned are skipped. If no matching [Theme] is found in the tree, a custom project [Theme] (see [member ProjectSettings.gui/theme/custom]) and the default [Theme] are used.
|
||||
[codeblocks]
|
||||
[gdscript]
|
||||
@ -462,7 +462,7 @@
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns a constant from the first matching [Theme] in the tree if that [Theme] has a constant item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
Returns a constant from the first matching [Theme] in the tree if that [Theme] has a constant item with the specified [param name] and [param theme_type].
|
||||
See [method get_theme_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
@ -492,7 +492,7 @@
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns a [Font] from the first matching [Theme] in the tree if that [Theme] has a font item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
Returns a [Font] from the first matching [Theme] in the tree if that [Theme] has a font item with the specified [param name] and [param theme_type].
|
||||
See [method get_theme_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
@ -501,7 +501,7 @@
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns a font size from the first matching [Theme] in the tree if that [Theme] has a font size item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
Returns a font size from the first matching [Theme] in the tree if that [Theme] has a font size item with the specified [param name] and [param theme_type].
|
||||
See [method get_theme_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
@ -510,7 +510,7 @@
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns an icon from the first matching [Theme] in the tree if that [Theme] has an icon item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
Returns an icon from the first matching [Theme] in the tree if that [Theme] has an icon item with the specified [param name] and [param theme_type].
|
||||
See [method get_theme_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
@ -519,7 +519,7 @@
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns a [StyleBox] from the first matching [Theme] in the tree if that [Theme] has a stylebox item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
Returns a [StyleBox] from the first matching [Theme] in the tree if that [Theme] has a stylebox item with the specified [param name] and [param theme_type].
|
||||
See [method get_theme_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
@ -565,7 +565,7 @@
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a color item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a color item with the specified [param name] and [param theme_type].
|
||||
See [method get_theme_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
@ -573,7 +573,7 @@
|
||||
<return type="bool" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a local override for a theme [Color] with the specified [code]name[/code] in this [Control] node.
|
||||
Returns [code]true[/code] if there is a local override for a theme [Color] with the specified [param name] in this [Control] node.
|
||||
See [method add_theme_color_override].
|
||||
</description>
|
||||
</method>
|
||||
@ -582,7 +582,7 @@
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a constant item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a constant item with the specified [param name] and [param theme_type].
|
||||
See [method get_theme_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
@ -590,7 +590,7 @@
|
||||
<return type="bool" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a local override for a theme constant with the specified [code]name[/code] in this [Control] node.
|
||||
Returns [code]true[/code] if there is a local override for a theme constant with the specified [param name] in this [Control] node.
|
||||
See [method add_theme_constant_override].
|
||||
</description>
|
||||
</method>
|
||||
@ -599,7 +599,7 @@
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a font item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a font item with the specified [param name] and [param theme_type].
|
||||
See [method get_theme_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
@ -607,7 +607,7 @@
|
||||
<return type="bool" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a local override for a theme [Font] with the specified [code]name[/code] in this [Control] node.
|
||||
Returns [code]true[/code] if there is a local override for a theme [Font] with the specified [param name] in this [Control] node.
|
||||
See [method add_theme_font_override].
|
||||
</description>
|
||||
</method>
|
||||
@ -616,7 +616,7 @@
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a font size item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a font size item with the specified [param name] and [param theme_type].
|
||||
See [method get_theme_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
@ -624,7 +624,7 @@
|
||||
<return type="bool" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a local override for a theme font size with the specified [code]name[/code] in this [Control] node.
|
||||
Returns [code]true[/code] if there is a local override for a theme font size with the specified [param name] in this [Control] node.
|
||||
See [method add_theme_font_size_override].
|
||||
</description>
|
||||
</method>
|
||||
@ -633,7 +633,7 @@
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a matching [Theme] in the tree that has an icon item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
Returns [code]true[/code] if there is a matching [Theme] in the tree that has an icon item with the specified [param name] and [param theme_type].
|
||||
See [method get_theme_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
@ -641,7 +641,7 @@
|
||||
<return type="bool" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a local override for a theme icon with the specified [code]name[/code] in this [Control] node.
|
||||
Returns [code]true[/code] if there is a local override for a theme icon with the specified [param name] in this [Control] node.
|
||||
See [method add_theme_icon_override].
|
||||
</description>
|
||||
</method>
|
||||
@ -650,7 +650,7 @@
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<param index="1" name="theme_type" type="StringName" default="""" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a stylebox item with the specified [code]name[/code] and [code]theme_type[/code].
|
||||
Returns [code]true[/code] if there is a matching [Theme] in the tree that has a stylebox item with the specified [param name] and [param theme_type].
|
||||
See [method get_theme_color] for details.
|
||||
</description>
|
||||
</method>
|
||||
@ -658,7 +658,7 @@
|
||||
<return type="bool" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Returns [code]true[/code] if there is a local override for a theme [StyleBox] with the specified [code]name[/code] in this [Control] node.
|
||||
Returns [code]true[/code] if there is a local override for a theme [StyleBox] with the specified [param name] in this [Control] node.
|
||||
See [method add_theme_stylebox_override].
|
||||
</description>
|
||||
</method>
|
||||
@ -685,42 +685,42 @@
|
||||
<return type="void" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Removes a local override for a theme [Color] with the specified [code]name[/code] previously added by [method add_theme_color_override] or via the Inspector dock.
|
||||
Removes a local override for a theme [Color] with the specified [param name] previously added by [method add_theme_color_override] or via the Inspector dock.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_theme_constant_override">
|
||||
<return type="void" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Removes a local override for a theme constant with the specified [code]name[/code] previously added by [method add_theme_constant_override] or via the Inspector dock.
|
||||
Removes a local override for a theme constant with the specified [param name] previously added by [method add_theme_constant_override] or via the Inspector dock.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_theme_font_override">
|
||||
<return type="void" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Removes a local override for a theme [Font] with the specified [code]name[/code] previously added by [method add_theme_font_override] or via the Inspector dock.
|
||||
Removes a local override for a theme [Font] with the specified [param name] previously added by [method add_theme_font_override] or via the Inspector dock.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_theme_font_size_override">
|
||||
<return type="void" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Removes a local override for a theme font size with the specified [code]name[/code] previously added by [method add_theme_font_size_override] or via the Inspector dock.
|
||||
Removes a local override for a theme font size with the specified [param name] previously added by [method add_theme_font_size_override] or via the Inspector dock.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_theme_icon_override">
|
||||
<return type="void" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Removes a local override for a theme icon with the specified [code]name[/code] previously added by [method add_theme_icon_override] or via the Inspector dock.
|
||||
Removes a local override for a theme icon with the specified [param name] previously added by [method add_theme_icon_override] or via the Inspector dock.
|
||||
</description>
|
||||
</method>
|
||||
<method name="remove_theme_stylebox_override">
|
||||
<return type="void" />
|
||||
<param index="0" name="name" type="StringName" />
|
||||
<description>
|
||||
Removes a local override for a theme [StyleBox] with the specified [code]name[/code] previously added by [method add_theme_stylebox_override] or via the Inspector dock.
|
||||
Removes a local override for a theme [StyleBox] with the specified [param name] previously added by [method add_theme_stylebox_override] or via the Inspector dock.
|
||||
</description>
|
||||
</method>
|
||||
<method name="reset_size">
|
||||
@ -736,9 +736,9 @@
|
||||
<param index="2" name="keep_offset" type="bool" default="false" />
|
||||
<param index="3" name="push_opposite_anchor" type="bool" default="true" />
|
||||
<description>
|
||||
Sets the anchor for the specified [enum Side] to [code]anchor[/code]. A setter method for [member anchor_bottom], [member anchor_left], [member anchor_right] and [member anchor_top].
|
||||
If [code]keep_offset[/code] is [code]true[/code], offsets aren't updated after this operation.
|
||||
If [code]push_opposite_anchor[/code] is [code]true[/code] and the opposite anchor overlaps this anchor, the opposite one will have its value overridden. For example, when setting left anchor to 1 and the right anchor has value of 0.5, the right anchor will also get value of 1. If [code]push_opposite_anchor[/code] was [code]false[/code], the left anchor would get value 0.5.
|
||||
Sets the anchor for the specified [enum Side] to [param anchor]. A setter method for [member anchor_bottom], [member anchor_left], [member anchor_right] and [member anchor_top].
|
||||
If [param keep_offset] is [code]true[/code], offsets aren't updated after this operation.
|
||||
If [param push_opposite_anchor] is [code]true[/code] and the opposite anchor overlaps this anchor, the opposite one will have its value overridden. For example, when setting left anchor to 1 and the right anchor has value of 0.5, the right anchor will also get value of 1. If [param push_opposite_anchor] was [code]false[/code], the left anchor would get value 0.5.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_anchor_and_offset">
|
||||
@ -765,8 +765,8 @@
|
||||
<param index="0" name="preset" type="int" enum="Control.LayoutPreset" />
|
||||
<param index="1" name="keep_offsets" type="bool" default="false" />
|
||||
<description>
|
||||
Sets the anchors to a [code]preset[/code] from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor.
|
||||
If [code]keep_offsets[/code] is [code]true[/code], control's position will also be updated.
|
||||
Sets the anchors to a [param preset] from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor.
|
||||
If [param keep_offsets] is [code]true[/code], control's position will also be updated.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_begin">
|
||||
@ -780,7 +780,7 @@
|
||||
<return type="void" />
|
||||
<param index="0" name="target" type="Object" />
|
||||
<description>
|
||||
Forwards the handling of this control's drag and drop to [code]target[/code] object.
|
||||
Forwards the handling of this control's drag and drop to [param target] object.
|
||||
Forwarding can be implemented in the target object similar to the methods [method _get_drag_data], [method _can_drop_data], and [method _drop_data] but with two differences:
|
||||
1. The function name must be suffixed with [b]_fw[/b]
|
||||
2. The function must take an extra argument that is the control doing the forwarding
|
||||
@ -887,7 +887,7 @@
|
||||
<param index="0" name="side" type="int" enum="Side" />
|
||||
<param index="1" name="neighbor" type="NodePath" />
|
||||
<description>
|
||||
Sets the anchor for the specified [enum Side] to the [Control] at [code]neighbor[/code] node path. A setter method for [member focus_neighbor_bottom], [member focus_neighbor_left], [member focus_neighbor_right] and [member focus_neighbor_top].
|
||||
Sets the anchor for the specified [enum Side] to the [Control] at [param neighbor] node path. A setter method for [member focus_neighbor_bottom], [member focus_neighbor_left], [member focus_neighbor_right] and [member focus_neighbor_top].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_global_position">
|
||||
@ -895,8 +895,8 @@
|
||||
<param index="0" name="position" type="Vector2" />
|
||||
<param index="1" name="keep_offsets" type="bool" default="false" />
|
||||
<description>
|
||||
Sets the [member global_position] to given [code]position[/code].
|
||||
If [code]keep_offsets[/code] is [code]true[/code], control's anchors will be updated instead of offsets.
|
||||
Sets the [member global_position] to given [param position].
|
||||
If [param keep_offsets] is [code]true[/code], control's anchors will be updated instead of offsets.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_offset">
|
||||
@ -904,7 +904,7 @@
|
||||
<param index="0" name="side" type="int" enum="Side" />
|
||||
<param index="1" name="offset" type="float" />
|
||||
<description>
|
||||
Sets the offset for the specified [enum Side] to [code]offset[/code]. A setter method for [member offset_bottom], [member offset_left], [member offset_right] and [member offset_top].
|
||||
Sets the offset for the specified [enum Side] to [param offset]. A setter method for [member offset_bottom], [member offset_left], [member offset_right] and [member offset_top].
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_offsets_preset">
|
||||
@ -913,9 +913,9 @@
|
||||
<param index="1" name="resize_mode" type="int" enum="Control.LayoutPresetMode" default="0" />
|
||||
<param index="2" name="margin" type="int" default="0" />
|
||||
<description>
|
||||
Sets the offsets to a [code]preset[/code] from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor.
|
||||
Use parameter [code]resize_mode[/code] with constants from [enum Control.LayoutPresetMode] to better determine the resulting size of the [Control]. Constant size will be ignored if used with presets that change size, e.g. [code]PRESET_LEFT_WIDE[/code].
|
||||
Use parameter [code]margin[/code] to determine the gap between the [Control] and the edges.
|
||||
Sets the offsets to a [param preset] from [enum Control.LayoutPreset] enum. This is the code equivalent to using the Layout menu in the 2D editor.
|
||||
Use parameter [param resize_mode] with constants from [enum Control.LayoutPresetMode] to better determine the resulting size of the [Control]. Constant size will be ignored if used with presets that change size, e.g. [code]PRESET_LEFT_WIDE[/code].
|
||||
Use parameter [param margin] to determine the gap between the [Control] and the edges.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_position">
|
||||
@ -923,8 +923,8 @@
|
||||
<param index="0" name="position" type="Vector2" />
|
||||
<param index="1" name="keep_offsets" type="bool" default="false" />
|
||||
<description>
|
||||
Sets the [member position] to given [code]position[/code].
|
||||
If [code]keep_offsets[/code] is [code]true[/code], control's anchors will be updated instead of offsets.
|
||||
Sets the [member position] to given [param position].
|
||||
If [param keep_offsets] is [code]true[/code], control's anchors will be updated instead of offsets.
|
||||
</description>
|
||||
</method>
|
||||
<method name="set_size">
|
||||
@ -933,7 +933,7 @@
|
||||
<param index="1" name="keep_offsets" type="bool" default="false" />
|
||||
<description>
|
||||
Sets the size (see [member size]).
|
||||
If [code]keep_offsets[/code] is [code]true[/code], control's anchors will be updated instead of offsets.
|
||||
If [param keep_offsets] is [code]true[/code], control's anchors will be updated instead of offsets.
|
||||
</description>
|
||||
</method>
|
||||
<method name="update_minimum_size">
|
||||
@ -946,7 +946,7 @@
|
||||
<return type="void" />
|
||||
<param index="0" name="position" type="Vector2" />
|
||||
<description>
|
||||
Moves the mouse cursor to [code]position[/code], relative to [member position] of this [Control].
|
||||
Moves the mouse cursor to [param position], relative to [member position] of this [Control].
|
||||
</description>
|
||||
</method>
|
||||
</methods>
|
||||
|
||||
Reference in New Issue
Block a user