Pixelpart 1.8.2
Godot Plugin
Loading...
Searching...
No Matches
godot::PixelpartNode Class Reference

An object in an effect like a particle emitter or a force field. More...

Inheritance diagram for godot::PixelpartNode:
[legend]

Public Member Functions

int get_id () const
 ID of the node.
 
int get_parent_id () const
 ID of the node's parent.
 
String get_name () const
 Name of the node.
 
void set_lifetime_start (float time)
 Set time until the node becomes active.
 
void set_lifetime_duration (float time)
 Set how long the node stays active in seconds.
 
void set_repeat (bool value)
 Set whether the node repeats its behavior after its lifetime is over.
 
float get_lifetime_start () const
 Time in seconds until the node becomes active.
 
float get_lifetime_duration () const
 How long the node is active in seconds.
 
bool get_repeat () const
 Wether the node repeats its behavior after its lifetime is over.
 
bool is_active () const
 Return whether the node is active at the current point in time.
 
float get_local_time () const
 Return the time fraction the emitter has been active for, in range 0.0 (0%) to 1.0 (100%).
 
Ref< PixelpartAnimatedPropertyFloat3get_position () const
 Position of the node.
 
Ref< PixelpartAnimatedPropertyFloat3get_rotation () const
 Rotation of the node in degrees.
 
Ref< PixelpartAnimatedPropertyFloat3get_scale () const
 Size of the node.
 

Public Attributes

float lifetime_start
 Time in seconds until the node becomes active.
 
float lifetime_duration
 How long the node stays active in seconds.
 
bool repeat
 Wether the node repeats its behavior after its lifetime is over.
 

Detailed Description

An object in an effect like a particle emitter or a force field.

Nodes can be moved, rotated and scaled and move together with their parent node if present.

Member Function Documentation

◆ get_id()

int godot::PixelpartNode::get_id ( ) const

ID of the node.

Returns
ID

◆ get_lifetime_duration()

float godot::PixelpartNode::get_lifetime_duration ( ) const

How long the node is active in seconds.

Returns
How long the node is active in seconds

◆ get_lifetime_start()

float godot::PixelpartNode::get_lifetime_start ( ) const

Time in seconds until the node becomes active.

Returns
Time in seconds until the node becomes active

◆ get_local_time()

float godot::PixelpartNode::get_local_time ( ) const

Return the time fraction the emitter has been active for, in range 0.0 (0%) to 1.0 (100%).

Returns
Time fraction the emitter has been active for

◆ get_name()

String godot::PixelpartNode::get_name ( ) const

Name of the node.

Returns
Name

◆ get_parent_id()

int godot::PixelpartNode::get_parent_id ( ) const

ID of the node's parent.

Returns
Parent ID or -1 if the node has no parent

◆ get_position()

Ref< PixelpartAnimatedPropertyFloat3 > godot::PixelpartNode::get_position ( ) const

Position of the node.

Returns
Position property

◆ get_repeat()

bool godot::PixelpartNode::get_repeat ( ) const

Wether the node repeats its behavior after its lifetime is over.

Returns
Wether the node repeats its behavior after its lifetime is over

◆ get_rotation()

Ref< PixelpartAnimatedPropertyFloat3 > godot::PixelpartNode::get_rotation ( ) const

Rotation of the node in degrees.

For 3D effects, the rotation is composed of roll, yaw and pitch.

Returns
Rotation property

◆ get_scale()

Ref< PixelpartAnimatedPropertyFloat3 > godot::PixelpartNode::get_scale ( ) const

Size of the node.

Returns
Scale property

◆ is_active()

bool godot::PixelpartNode::is_active ( ) const

Return whether the node is active at the current point in time.

Returns
Whether the node is active at the current point in time.

◆ set_lifetime_duration()

void godot::PixelpartNode::set_lifetime_duration ( float time)

Set how long the node stays active in seconds.

Parameters
timeHow long the node stays active in seconds

◆ set_lifetime_start()

void godot::PixelpartNode::set_lifetime_start ( float time)

Set time until the node becomes active.

Parameters
timeTime in seconds until the node becomes active

◆ set_repeat()

void godot::PixelpartNode::set_repeat ( bool value)

Set whether the node repeats its behavior after its lifetime is over.

Parameters
valueWether the node repeats its behavior after its lifetime is over

The documentation for this class was generated from the following files: