This contains the source code documentation of the class DialogicNode_PortraitContainer.
DialogicNode_PortraitContainer
Inherits: Control
Node that defines a position for dialogic portraits and how to display portraits at that position.
Properties
| Name | Type | Default |
|---|---|---|
| mode | int | 0 |
| container_ids | PackedStringArray | [...] |
| portrait_prefix | String | "" |
| size_mode | int | 3 |
| mirrored | bool | false |
| origin_anchor | int | 7 |
| origin_offset | Vector2 | Vector2(0, 0) |
| pivot_mode | int | 0 |
| pivot_value | Vector2 | Vector2(0, 0) |
| debug_character | DialogicCharacter | null |
| debug_character_portrait | String | "" |
| debug_character_holder_node | Node2D | null |
| debug_character_scene_node | Node | null |
| debug_origin | Sprite2D | null |
| default_portrait_scene | String | path_join(...) |
| default_debug_character | Resource | load(...) |
| ignore_resize | bool | false |
Methods
| Returns | Method |
|---|---|
| void | update_portrait_transforms ( ) |
| Rect2 | get_local_portrait_transform ( portrait_rect: Rect2, character_scale: float = 1.0 ) |
| bool | is_container ( id: Variant ) |
Constants
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
No description available.
Property Descriptions
No description available.
The position this node corresponds to.
Can be used to use a different portrait. E.g. "Faces/" would mean instead of "happy" it will use portrait "Faces/happy"
Defines how to affect the scale of the portrait
If true, portraits will be mirrored in this position.
The portrait will be placed relative to this point in the container.
var origin_offset = Vector2(0, 0)
An offset to apply to the origin. Rarely useful.
Usually you want to rotate or scale around the portrait origin. For the moments where that is not the case, set the mode to PERCENTAGE or PIXELS and use pivot_value.
var pivot_value = Vector2(0, 0)
Only has an effect when pivot_mode is not AT_ORIGIN. Meaning depends on whether pivot_mode is PERCENTAGE or PIXELS.
A character that will be displayed in the editor, useful for getting the right size.
var debug_character_portrait = ""
No description available.
var debug_character_holder_node = null
No description available.
var debug_character_scene_node = null
No description available.
No description available.
var default_portrait_scene = path_join(...)
No description available.
var default_debug_character = load(...)
No description available.
No description available.
Method Descriptions
func update_portrait_transforms ( ) ⇒ void
No description available.
func get_local_portrait_transform ( portrait_rect: Rect2, character_scale: float = 1.0 ) ⇒ Rect2
Returns a Rect2 with the position as the position and the scale as the size.
func is_container ( id: Variant ) ⇒ bool
No description available.