LookAtModifier3D

Documentation

Overview

Package LookAtModifier3D provides methods for working with LookAtModifier3D object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsLookAtModifier3D() Instance
  • func (self Instance) AsNode() Node.Instance
  • func (self Instance) AsNode3D() Node3D.Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsSkeletonModifier3D() SkeletonModifier3D.Instance
  • func (self Instance) Bone() int
  • func (self Instance) BoneName() string
  • func (self Instance) Duration() Float.X
  • func (self Instance) EaseType() gdclass.TweenEaseType
  • func (self Instance) ForwardAxis() gdclass.SkeletonModifier3DBoneAxis
  • func (self Instance) GetInterpolationRemaining() Float.X
  • func (self Instance) IsInterpolating() bool
  • func (self Instance) IsTargetWithinLimitation() bool
  • func (self Instance) OriginBone() int
  • func (self Instance) OriginBoneName() string
  • func (self Instance) OriginExternalNode() string
  • func (self Instance) OriginFrom() gdclass.LookAtModifier3DOriginFrom
  • func (self Instance) OriginOffset() Vector3.XYZ
  • func (self Instance) OriginSafeMargin() Float.X
  • func (self Instance) PrimaryDampThreshold() Float.X
  • func (self Instance) PrimaryLimitAngle() Float.X
  • func (self Instance) PrimaryNegativeDampThreshold() Float.X
  • func (self Instance) PrimaryNegativeLimitAngle() Float.X
  • func (self Instance) PrimaryPositiveDampThreshold() Float.X
  • func (self Instance) PrimaryPositiveLimitAngle() Float.X
  • func (self Instance) PrimaryRotationAxis() gd.Vector3Axis
  • func (self Instance) SecondaryDampThreshold() Float.X
  • func (self Instance) SecondaryLimitAngle() Float.X
  • func (self Instance) SecondaryNegativeDampThreshold() Float.X
  • func (self Instance) SecondaryNegativeLimitAngle() Float.X
  • func (self Instance) SecondaryPositiveDampThreshold() Float.X
  • func (self Instance) SecondaryPositiveLimitAngle() Float.X
  • func (self Instance) SetBone(value int)
  • func (self Instance) SetBoneName(value string)
  • func (self Instance) SetDuration(value Float.X)
  • func (self Instance) SetEaseType(value gdclass.TweenEaseType)
  • func (self Instance) SetForwardAxis(value gdclass.SkeletonModifier3DBoneAxis)
  • func (self Instance) SetOriginBone(value int)
  • func (self Instance) SetOriginBoneName(value string)
  • func (self Instance) SetOriginExternalNode(value string)
  • func (self Instance) SetOriginFrom(value gdclass.LookAtModifier3DOriginFrom)
  • func (self Instance) SetOriginOffset(value Vector3.XYZ)
  • func (self Instance) SetOriginSafeMargin(value Float.X)
  • func (self Instance) SetPrimaryDampThreshold(value Float.X)
  • func (self Instance) SetPrimaryLimitAngle(value Float.X)
  • func (self Instance) SetPrimaryNegativeDampThreshold(value Float.X)
  • func (self Instance) SetPrimaryNegativeLimitAngle(value Float.X)
  • func (self Instance) SetPrimaryPositiveDampThreshold(value Float.X)
  • func (self Instance) SetPrimaryPositiveLimitAngle(value Float.X)
  • func (self Instance) SetPrimaryRotationAxis(value gd.Vector3Axis)
  • func (self Instance) SetSecondaryDampThreshold(value Float.X)
  • func (self Instance) SetSecondaryLimitAngle(value Float.X)
  • func (self Instance) SetSecondaryNegativeDampThreshold(value Float.X)
  • func (self Instance) SetSecondaryNegativeLimitAngle(value Float.X)
  • func (self Instance) SetSecondaryPositiveDampThreshold(value Float.X)
  • func (self Instance) SetSecondaryPositiveLimitAngle(value Float.X)
  • func (self Instance) SetSymmetryLimitation(value bool)
  • func (self Instance) SetTargetNode(value string)
  • func (self Instance) SetTransitionType(value gdclass.TweenTransitionType)
  • func (self Instance) SetUseAngleLimitation(value bool)
  • func (self Instance) SetUseSecondaryRotation(value bool)
  • func (self Instance) SymmetryLimitation() bool
  • func (self Instance) TargetNode() string
  • func (self Instance) TransitionType() gdclass.TweenTransitionType
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) UseAngleLimitation() bool
  • func (self Instance) UseSecondaryRotation() bool
  • func (self Instance) Virtual(name string) reflect.Value
• type OriginFrom

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsLookAtModifier3D() Instance
}

type Instance

type Instance [1]gdclass.LookAtModifier3D

This [SkeletonModifier3D] rotates a bone to look at a target. This is helpful for moving a character's head to look at the player, rotating a turret to look at a target, or any other case where you want to make a bone rotate towards something quickly and easily. When applying multiple [LookAtModifier3D]s, the [LookAtModifier3D] assigned to the parent bone must be put above the [LookAtModifier3D] assigned to the child bone in the list in order for the child bone results to be correct.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsLookAtModifier3D

func (self Instance) AsLookAtModifier3D() Instance

func (Instance) AsNode

func (self Instance) AsNode() Node.Instance

func (Instance) AsNode3D

func (self Instance) AsNode3D() Node3D.Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsSkeletonModifier3D

func (self Instance) AsSkeletonModifier3D() SkeletonModifier3D.Instance

func (Instance) Bone

func (self Instance) Bone() int

func (Instance) BoneName

func (self Instance) BoneName() string

func (Instance) Duration

func (self Instance) Duration() Float.X

func (Instance) EaseType

func (self Instance) EaseType() gdclass.TweenEaseType

func (Instance) ForwardAxis

func (self Instance) ForwardAxis() gdclass.SkeletonModifier3DBoneAxis

func (Instance) GetInterpolationRemaining

func (self Instance) GetInterpolationRemaining() Float.X

Returns the remaining seconds of the time-based interpolation.

func (Instance) IsInterpolating

func (self Instance) IsInterpolating() bool

Returns whether the time-based interpolation is running or not. If [code]true[/code], it is equivalent to [method get_interpolation_remaining] being [code]0[/code]. This is useful to determine whether a [LookAtModifier3D] can be removed safely.

func (Instance) IsTargetWithinLimitation

func (self Instance) IsTargetWithinLimitation() bool

Returns whether the target is within the angle limitations. It is useful for unsetting the [member target_node] when the target is outside of the angle limitations. [b]Note:[/b] The value is updated after [method SkeletonModifier3D._process_modification]. To retrieve this value correctly, we recommend using the signal [signal SkeletonModifier3D.modification_processed].

func (Instance) OriginBone

func (self Instance) OriginBone() int

func (Instance) OriginBoneName

func (self Instance) OriginBoneName() string

func (Instance) OriginExternalNode

func (self Instance) OriginExternalNode() string

func (Instance) OriginFrom

func (self Instance) OriginFrom() gdclass.LookAtModifier3DOriginFrom

func (Instance) OriginOffset

func (self Instance) OriginOffset() Vector3.XYZ

func (Instance) OriginSafeMargin

func (self Instance) OriginSafeMargin() Float.X

func (Instance) PrimaryDampThreshold

func (self Instance) PrimaryDampThreshold() Float.X

func (Instance) PrimaryLimitAngle

func (self Instance) PrimaryLimitAngle() Float.X

func (Instance) PrimaryNegativeDampThreshold

func (self Instance) PrimaryNegativeDampThreshold() Float.X

func (Instance) PrimaryNegativeLimitAngle

func (self Instance) PrimaryNegativeLimitAngle() Float.X

func (Instance) PrimaryPositiveDampThreshold

func (self Instance) PrimaryPositiveDampThreshold() Float.X

func (Instance) PrimaryPositiveLimitAngle

func (self Instance) PrimaryPositiveLimitAngle() Float.X

func (Instance) PrimaryRotationAxis

func (self Instance) PrimaryRotationAxis() gd.Vector3Axis

func (Instance) SecondaryDampThreshold

func (self Instance) SecondaryDampThreshold() Float.X

func (Instance) SecondaryLimitAngle

func (self Instance) SecondaryLimitAngle() Float.X

func (Instance) SecondaryNegativeDampThreshold

func (self Instance) SecondaryNegativeDampThreshold() Float.X

func (Instance) SecondaryNegativeLimitAngle

func (self Instance) SecondaryNegativeLimitAngle() Float.X

func (Instance) SecondaryPositiveDampThreshold

func (self Instance) SecondaryPositiveDampThreshold() Float.X

func (Instance) SecondaryPositiveLimitAngle

func (self Instance) SecondaryPositiveLimitAngle() Float.X

func (Instance) SetBone

func (self Instance) SetBone(value int)

func (Instance) SetBoneName

func (self Instance) SetBoneName(value string)

func (Instance) SetDuration

func (self Instance) SetDuration(value Float.X)

func (Instance) SetEaseType

func (self Instance) SetEaseType(value gdclass.TweenEaseType)

func (Instance) SetForwardAxis

func (self Instance) SetForwardAxis(value gdclass.SkeletonModifier3DBoneAxis)

func (Instance) SetOriginBone

func (self Instance) SetOriginBone(value int)

func (Instance) SetOriginBoneName

func (self Instance) SetOriginBoneName(value string)

func (Instance) SetOriginExternalNode

func (self Instance) SetOriginExternalNode(value string)

func (Instance) SetOriginFrom

func (self Instance) SetOriginFrom(value gdclass.LookAtModifier3DOriginFrom)

func (Instance) SetOriginOffset

func (self Instance) SetOriginOffset(value Vector3.XYZ)

func (Instance) SetOriginSafeMargin

func (self Instance) SetOriginSafeMargin(value Float.X)

func (Instance) SetPrimaryDampThreshold

func (self Instance) SetPrimaryDampThreshold(value Float.X)

func (Instance) SetPrimaryLimitAngle

func (self Instance) SetPrimaryLimitAngle(value Float.X)

func (Instance) SetPrimaryNegativeDampThreshold

func (self Instance) SetPrimaryNegativeDampThreshold(value Float.X)

func (Instance) SetPrimaryNegativeLimitAngle

func (self Instance) SetPrimaryNegativeLimitAngle(value Float.X)

func (Instance) SetPrimaryPositiveDampThreshold

func (self Instance) SetPrimaryPositiveDampThreshold(value Float.X)

func (Instance) SetPrimaryPositiveLimitAngle

func (self Instance) SetPrimaryPositiveLimitAngle(value Float.X)

func (Instance) SetPrimaryRotationAxis

func (self Instance) SetPrimaryRotationAxis(value gd.Vector3Axis)

func (Instance) SetSecondaryDampThreshold

func (self Instance) SetSecondaryDampThreshold(value Float.X)

func (Instance) SetSecondaryLimitAngle

func (self Instance) SetSecondaryLimitAngle(value Float.X)

func (Instance) SetSecondaryNegativeDampThreshold

func (self Instance) SetSecondaryNegativeDampThreshold(value Float.X)

func (Instance) SetSecondaryNegativeLimitAngle

func (self Instance) SetSecondaryNegativeLimitAngle(value Float.X)

func (Instance) SetSecondaryPositiveDampThreshold

func (self Instance) SetSecondaryPositiveDampThreshold(value Float.X)

func (Instance) SetSecondaryPositiveLimitAngle

func (self Instance) SetSecondaryPositiveLimitAngle(value Float.X)

func (Instance) SetSymmetryLimitation

func (self Instance) SetSymmetryLimitation(value bool)

func (Instance) SetTargetNode

func (self Instance) SetTargetNode(value string)

func (Instance) SetTransitionType

func (self Instance) SetTransitionType(value gdclass.TweenTransitionType)

func (Instance) SetUseAngleLimitation

func (self Instance) SetUseAngleLimitation(value bool)

func (Instance) SetUseSecondaryRotation

func (self Instance) SetUseSecondaryRotation(value bool)

func (Instance) SymmetryLimitation

func (self Instance) SymmetryLimitation() bool

func (Instance) TargetNode

func (self Instance) TargetNode() string

func (Instance) TransitionType

func (self Instance) TransitionType() gdclass.TweenTransitionType

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) UseAngleLimitation

func (self Instance) UseAngleLimitation() bool

func (Instance) UseSecondaryRotation

func (self Instance) UseSecondaryRotation() bool

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

type OriginFrom

type OriginFrom = gdclass.LookAtModifier3DOriginFrom //gd:LookAtModifier3D.OriginFrom

const (
	/*The bone rest position of the bone specified in [member bone] is used as origin.*/
	OriginFromSelf OriginFrom = 0
	/*The bone global pose position of the bone specified in [member origin_bone] is used as origin.
	  [b]Note:[/b] It is recommended that you select only the parent bone unless you are familiar with the bone processing process. The specified bone pose at the time the [LookAtModifier3D] is processed is used as a reference. In other words, if you specify a child bone and the [LookAtModifier3D] causes the child bone to move, the rendered result and direction will not match.*/
	OriginFromSpecificBone OriginFrom = 1
	/*The global position of the [Node3D] specified in [member origin_external_node] is used as origin.
	  [b]Note:[/b] Same as [constant ORIGIN_FROM_SPECIFIC_BONE], when specifying a [BoneAttachment3D] with a child bone assigned, the rendered result and direction will not match.*/
	OriginFromExternalNode OriginFrom = 2
)