Struct gdnative_bindings_lily::ProgressBar [−][src]
pub struct ProgressBar { /* fields omitted */ }
Expand description
core class ProgressBar
inherits Range
(unsafe).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Memory management
Non reference counted objects such as the ones of this type are usually owned by the engine.
ProgressBar
is a reference-only type. Persistent references can
only exist in the unsafe Ref<ProgressBar>
form.
In the cases where Rust code owns an object of this type, for example if the object was just
created on the Rust side and not passed to the engine yet, ownership should be either given
to the engine or the object must be manually destroyed using Ref::free
, or Ref::queue_free
if it is a Node
.
Class hierarchy
ProgressBar inherits methods from:
Safety
All types in the Godot API have “interior mutability” in Rust parlance.
To enforce that the official thread-safety guidelines are
followed, the typestate pattern is used in the Ref
and TRef
smart pointers,
and the Instance
API. The typestate Access
in these types tracks whether the
access is unique, shared, or exclusive to the current thread. For more information,
see the type-level documentation on Ref
.
Implementations
Creates a new instance of this object.
Because this type is not reference counted, the lifetime of the returned object is not automatically managed.
Immediately after creation, the object is owned by the caller, and can be
passed to the engine (in which case the engine will be responsible for
destroying the object) or destroyed manually using Ref::free
, or preferably
Ref::queue_free
if it is a Node
.
If true
, the fill percentage is displayed on the bar.
If true
, the fill percentage is displayed on the bar.
Methods from Deref<Target = Range>
Page size. Used mainly for ScrollBar. ScrollBar’s length is its size multiplied by page
over the difference between min_value
and max_value
.
If greater than 0, value
will always be rounded to a multiple of step
. If rounded
is also true
, value
will first be rounded to a multiple of step
then rounded to the nearest integer.
If true
, [member value] may be greater than [member max_value].
If true
, [member value] may be less than [member min_value].
If true
, and min_value
is greater than 0, value
will be represented exponentially rather than linearly.
If true
, value
will always be rounded to the nearest integer.
If true
, [member value] may be greater than [member max_value].
If true
, [member value] may be less than [member min_value].
The value mapped between 0 and 1.
If true
, and min_value
is greater than 0, value
will be represented exponentially rather than linearly.
Maximum value. Range is clamped if value
is greater than max_value
.
Minimum value. Range is clamped if value
is less than min_value
.
Page size. Used mainly for ScrollBar. ScrollBar’s length is its size multiplied by page
over the difference between min_value
and max_value
.
If greater than 0, value
will always be rounded to a multiple of step
. If rounded
is also true
, value
will first be rounded to a multiple of step
then rounded to the nearest integer.
If true
, value
will always be rounded to the nearest integer.
Binds two ranges together along with any ranges previously grouped with either of them. When any of range’s member variables change, it will share the new value with all other ranges in its group.
Stops range from sharing its member variables with any other.
Trait Implementations
type RefKind = ManuallyManaged
type RefKind = ManuallyManaged
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
Creates a persistent reference to the same Godot object with thread-local thread access. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for ProgressBar
impl !Send for ProgressBar
impl !Sync for ProgressBar
impl Unpin for ProgressBar
impl UnwindSafe for ProgressBar