Class: MG::Sprite
Properties (collapse)
-
- (Integer) category_mask
Physics category mask.
-
- (Integer) collision_mask
Physics collision mask.
-
- (Integer) contact_mask
Physics contact test mask.
-
- (Boolean) dynamic?
Whether the sprite body should be dynamic or not in the physics world.
-
- (Float) friction
The linear damping / air friction force on the sprite body.
-
- (Boolean) gravitates?
Whether the sprite should be affected by the scene's gravitational force.
-
- (Float) inertia_moment
The moment of inertia of the body.
-
- (Float) mass
The body mass of the sprite.
-
- (Boolean) resting?
Whether the body is at rest.
-
- (Point) velocity
The velocity force on the sprite body.
Attributes inherited from Node
#alpha, #anchor_point, #color, #name, #position, #rotation, #scale, #size, #visible?, #z_index
Spritesheets (collapse)
-
+ (nil) load(file_name)
Loads all sprites from the content of
file_name
, which should be the name of a property list spritesheet file in the application's resource directory.
Constructors (collapse)
-
- (Sprite) initialize(sprite_name)
constructor
Creates a new sprite object from
sprite_name
, which must be either the name of a standalone image file in the application's resource directory or the name of a sprite frame which was loaded from a spritesheet using Sprite.load.
Actions (collapse)
-
- (Sprite) animate(frame_names, delay, loops = 1)
Starts an animation where the sprite display frame will be changed to the given frames in
sprite_frames_names
based on the givendelay
and repeatedloops
times. -
- (Sprite) blink(number_of_blinks, interval)
Blinks the receiver.
-
- (Sprite) move_by(delta_location, interval)
Moves the position of the receiver to a new location determined by the sum of the current location and the given
delta_location
object. -
- (Sprite) move_to(location, interval)
Moves the position of the receiver to a new given location.
Physics (collapse)
-
- (Sprite) apply_force(force)
Applies an immediate force to the sprite body.
-
- (Sprite) apply_impulse(force)
Applies a continuous force to the sprite body.
-
- (Sprite) attach_physics_box(size = nil)
Attaches a physics body with a box shape to the sprite.
Methods inherited from Node
#add, #children, #clear, #delete, #delete_from_parent, #intersects?, #parent
Constructor Details
- (Sprite) initialize(sprite_name)
Creates a new sprite object from sprite_name
, which must be
either the name of a standalone image file in the application's
resource directory or the name of a sprite frame which was loaded from a
spritesheet using load.
499 |
# File 'motion-game', line 499 def initialize(sprite_name); end |
Instance Attribute Details
- (Integer) category_mask
Returns physics category mask.
585 586 587 |
# File 'motion-game', line 585 def category_mask @category_mask end |
- (Integer) collision_mask
Returns physics collision mask.
591 592 593 |
# File 'motion-game', line 591 def collision_mask @collision_mask end |
- (Integer) contact_mask
Returns physics contact test mask.
588 589 590 |
# File 'motion-game', line 588 def contact_mask @contact_mask end |
- (Boolean) dynamic?
Returns whether the sprite body should be dynamic or not in the physics
world. The default is true
, and a dynamic body will affect
with gravity.
570 571 572 |
# File 'motion-game', line 570
def dynamic?
@dynamic?
end
|
- (Float) friction
Returns the linear damping / air friction force on the sprite body.
573 574 575 |
# File 'motion-game', line 573 def friction @friction end |
- (Boolean) gravitates?
Returns whether the sprite should be affected by the scene's
gravitational force. The default is true
.
565 566 567 |
# File 'motion-game', line 565
def gravitates?
@gravitates?
end
|
- (Float) inertia_moment
Returns the moment of inertia of the body.
582 583 584 |
# File 'motion-game', line 582 def inertia_moment @inertia_moment end |
- (Float) mass
Returns the body mass of the sprite.
561 562 563 |
# File 'motion-game', line 561 def mass @mass end |
- (Boolean) resting?
Returns whether the body is at rest.
579 580 581 |
# File 'motion-game', line 579
def resting?
@resting?
end
|
- (Point) velocity
Returns the velocity force on the sprite body.
576 577 578 |
# File 'motion-game', line 576 def velocity @velocity end |
Class Method Details
+ (nil) load(file_name)
Loads all sprites from the content of file_name
, which should
be the name of a property list spritesheet file in the application's
resource directory. Once a spritesheet file is loaded, individual sprites
can be created using #initialize by providing the name of the
frame. Sprite frames files can be created with a visual editor such as
TexturePacker.
489 |
# File 'motion-game', line 489 def self.load(file_name); end |
Instance Method Details
- (Sprite) animate(frame_names, delay, loops = 1)
Starts an animation where the sprite display frame will be changed to the
given frames in sprite_frames_names
based on the given
delay
and repeated loops
times.
536 |
# File 'motion-game', line 536 def animate(frame_names, delay, loops=1); end |
- (Sprite) apply_force(force)
Applies an immediate force to the sprite body.
555 |
# File 'motion-game', line 555 def apply_force(force); end |
- (Sprite) apply_impulse(force)
Applies a continuous force to the sprite body.
550 |
# File 'motion-game', line 550 def apply_impulse(force); end |
- (Sprite) attach_physics_box(size = nil)
Attaches a physics body with a box shape to the sprite.
545 |
# File 'motion-game', line 545 def attach_physics_box(size=nil); end |
- (Sprite) blink(number_of_blinks, interval)
Blinks the receiver.
523 |
# File 'motion-game', line 523 def blink(number_of_blinks, interval); end |
- (Sprite) move_by(delta_location, interval)
Moves the position of the receiver to a new location determined by the sum
of the current location and the given delta_location
object.
510 |
# File 'motion-game', line 510 def move_by(delta_location, interval); end |
- (Sprite) move_to(location, interval)
Moves the position of the receiver to a new given location.
516 |
# File 'motion-game', line 516 def move_to(location, interval); end |