events

Methods

(inner) collision(block_a, block_b, P1, P2) → {event}

Description:
  • Listens to when two collision blocks collide
Source:
Parameters:
Name Type Description
block_a block First block to listen to
block_b block Second block to listen to
P1 boolean Player 1 as block a
P2 boolean Player 2 as block a
Returns:
Type
event

(inner) collision_exit(block_a, block_b, P1, P2) → {event}

Description:
  • Listens to when two collision blocks stop colliding
Source:
Parameters:
Name Type Description
block_a block First block to listen to
block_b block Second block to listen to
P1 boolean Player 1 as block a
P2 boolean Player 2 as block a
Returns:
Type
event

(inner) count(item, num, multi) → {event}

Description:
  • Listens to when an item hits a specific number
Source:
Parameters:
Name Type Description
item item Item to listen to
num number Number that triggers event when the item hits this
multi boolean Whether to trigger the event multiple time
Returns:
Type
event

(inner) death() → {event}

Description:
  • Listens to when the player dies
Source:
Returns:
Type
event

(inner) event(event, extra_id, extra_id2) → {event}

Description:
  • Implementation of the event trigger that triggers an event
Source:
Parameters:
Name Type Description
event array | event_id Event(s) to be listened to (look at Events for more info)
extra_id number Implementation of extra ID 1
extra_id2 number Implementation of extra ID 2
Returns:
Type
event

(inner) frame()

Description:
  • Event that runs on every frame
Source:

(inner) gamescene() → {gamescene}

Description:
  • Simple input control abstraction
Source:
Returns:
Type
gamescene

(inner) on(event, group)

Description:
  • Calls a group when an event occurs
Source:
Parameters:
Name Type Description
event event Event to listen to
group group Group of object

(inner) touch(dual_sideopt) → {event}

Description:
  • Listens to when the screen is touched
Source:
Parameters:
Name Type Attributes Default Description
dual_side boolean <optional>
false Whether to only listen to dual side
Returns:
Type
event

(inner) touch_end(dual_sideopt) → {event}

Description:
  • Listens to when the screen stops being touched
Source:
Parameters:
Name Type Attributes Default Description
dual_side boolean <optional>
false Whether to only listen to dual side
Returns:
Type
event

(inner) x_position(x) → {event}

Description:
  • Listens to when the player reaches a specific X position
Source:
Parameters:
Name Type Description
x number X position where event is called
Returns:
Type
event

Type Definitions

events

Source:
Properties:
Name Type Description
NONE number
TINY_LANDING number
FEATHER_LANDING number
SOFT_LANDING number
NORMAL_LANDING number
HARD_LANDING number
HIT_HEAD number
ORB_TOUCHED number
ORB_ACTIVATED number
PAD_ACTIVATED number
GRAVITY_INVERTED number
GRAVITY_RESTORED number
NORMAL_JUMP number
ROBOT_BOOST_START number
ROBOT_BOOST_STOP number
UFO_JUMP number
SHIP_BOOST_START number
SHIP_BOOST_END number
SPIDER_TELEPORT number
BALL_SWITCH number
SWING_SWITCH number
WAVE_PUSH number
WAVE_RELEASE number
DASH_START number
DASH_STOP number
TELEPORTED number
PORTAL_NORMAL number
PORTAL_SHIP number
PORTAL_BALL number
PORTAL_UFO number
PORTAL_WAVE number
PORTAL_ROBOT number
PORTAL_SPIDER number
PORTAL_SWING number
YELLOW_ORB number
PINK_ORB number
RED_ORB number
GRAVITY_ORB number
GREEN_ORB number
DROP_ORB number
CUSTOM_ORB number
DASH_ORB number
GRAVITY_DASH_ORB number
SPIDER_ORB number
TELEPORT_ORB number
YELLOW_PAD number
PINK_PAD number
RED_PAD number
GRAVITY_PAD number
SPIDER_PAD number
PORTAL_GRAVITY_FLIP number
PORTAL_GRAVITY_NORMAL number
PORTAL_GRAVITY_INVERT number
PORTAL_FLIP number
PORTAL_UNFLIP number
PORTAL_NORMAL_SCALE number
PORTAL_MINI_SCALE number
PORTAL_DUAL_ON number
PORTAL_DUAL_OFF number
PORTAL_TELEPORT number
CHECKPOINT number
DESTROY_BLOCK number
USER_COIN number
PICKUP_ITEM number
CHECKPOINT_RESPAWN number
FALL_LOW number
FALL_MED number
FALL_HIGH number
FALL_VHIGH number
JUMP_PUSH number
JUMP_RELEASE number
LEFT_PUSH number
LEFT_RELEASE number
RIGHT_PUSH number
RIGHT_RELEASE number
PLAYER_REVERSED number
FALL_SPEED_LOW number
FALL_SPEED_MED number
FALL_SPEED_HIGH number
Type:
  • object

gamescene

Description:
  • Represents gamescene (all functions in this type are made to be used with on())
Source:
Properties:
Name Type Description
button_a function Returns an event when the left side is pressed
button_b function Returns an event when the right side is pressed
button_a_end function Returns an event when the left side is no longer pressed
button_b_end function Returns an event when the right side is no longer pressed
stop stop Stops playing the song
Represents gamescene (all functions in this type are made to be used with on())
Type:
  • object

Methods

(inner) collision(block_a, block_b, P1, P2) → {event}

Description:
  • Listens to when two collision blocks collide
Source:
Parameters:
Name Type Description
block_a block First block to listen to
block_b block Second block to listen to
P1 boolean Player 1 as block a
P2 boolean Player 2 as block a
Returns:
Type
event

(inner) collision_exit(block_a, block_b, P1, P2) → {event}

Description:
  • Listens to when two collision blocks stop colliding
Source:
Parameters:
Name Type Description
block_a block First block to listen to
block_b block Second block to listen to
P1 boolean Player 1 as block a
P2 boolean Player 2 as block a
Returns:
Type
event

(inner) count(item, num, multi) → {event}

Description:
  • Listens to when an item hits a specific number
Source:
Parameters:
Name Type Description
item item Item to listen to
num number Number that triggers event when the item hits this
multi boolean Whether to trigger the event multiple time
Returns:
Type
event

(inner) death() → {event}

Description:
  • Listens to when the player dies
Source:
Returns:
Type
event

(inner) event(event, extra_id, extra_id2) → {event}

Description:
  • Implementation of the event trigger that triggers an event
Source:
Parameters:
Name Type Description
event array | event_id Event(s) to be listened to (look at Events for more info)
extra_id number Implementation of extra ID 1
extra_id2 number Implementation of extra ID 2
Returns:
Type
event

(inner) frame()

Description:
  • Event that runs on every frame
Source:

(inner) gamescene() → {gamescene}

Description:
  • Simple input control abstraction
Source:
Returns:
Type
gamescene

(inner) on(event, group)

Description:
  • Calls a group when an event occurs
Source:
Parameters:
Name Type Description
event event Event to listen to
group group Group of object

(inner) touch(dual_sideopt) → {event}

Description:
  • Listens to when the screen is touched
Source:
Parameters:
Name Type Attributes Default Description
dual_side boolean <optional>
false Whether to only listen to dual side
Returns:
Type
event

(inner) touch_end(dual_sideopt) → {event}

Description:
  • Listens to when the screen stops being touched
Source:
Parameters:
Name Type Attributes Default Description
dual_side boolean <optional>
false Whether to only listen to dual side
Returns:
Type
event

(inner) x_position(x) → {event}

Description:
  • Listens to when the player reaches a specific X position
Source:
Parameters:
Name Type Description
x number X position where event is called
Returns:
Type
event

Type Definitions

events

Source:
Properties:
Name Type Description
NONE number
TINY_LANDING number
FEATHER_LANDING number
SOFT_LANDING number
NORMAL_LANDING number
HARD_LANDING number
HIT_HEAD number
ORB_TOUCHED number
ORB_ACTIVATED number
PAD_ACTIVATED number
GRAVITY_INVERTED number
GRAVITY_RESTORED number
NORMAL_JUMP number
ROBOT_BOOST_START number
ROBOT_BOOST_STOP number
UFO_JUMP number
SHIP_BOOST_START number
SHIP_BOOST_END number
SPIDER_TELEPORT number
BALL_SWITCH number
SWING_SWITCH number
WAVE_PUSH number
WAVE_RELEASE number
DASH_START number
DASH_STOP number
TELEPORTED number
PORTAL_NORMAL number
PORTAL_SHIP number
PORTAL_BALL number
PORTAL_UFO number
PORTAL_WAVE number
PORTAL_ROBOT number
PORTAL_SPIDER number
PORTAL_SWING number
YELLOW_ORB number
PINK_ORB number
RED_ORB number
GRAVITY_ORB number
GREEN_ORB number
DROP_ORB number
CUSTOM_ORB number
DASH_ORB number
GRAVITY_DASH_ORB number
SPIDER_ORB number
TELEPORT_ORB number
YELLOW_PAD number
PINK_PAD number
RED_PAD number
GRAVITY_PAD number
SPIDER_PAD number
PORTAL_GRAVITY_FLIP number
PORTAL_GRAVITY_NORMAL number
PORTAL_GRAVITY_INVERT number
PORTAL_FLIP number
PORTAL_UNFLIP number
PORTAL_NORMAL_SCALE number
PORTAL_MINI_SCALE number
PORTAL_DUAL_ON number
PORTAL_DUAL_OFF number
PORTAL_TELEPORT number
CHECKPOINT number
DESTROY_BLOCK number
USER_COIN number
PICKUP_ITEM number
CHECKPOINT_RESPAWN number
FALL_LOW number
FALL_MED number
FALL_HIGH number
FALL_VHIGH number
JUMP_PUSH number
JUMP_RELEASE number
LEFT_PUSH number
LEFT_RELEASE number
RIGHT_PUSH number
RIGHT_RELEASE number
PLAYER_REVERSED number
FALL_SPEED_LOW number
FALL_SPEED_MED number
FALL_SPEED_HIGH number
Type:
  • object

gamescene

Description:
  • Represents gamescene (all functions in this type are made to be used with on())
Source:
Properties:
Name Type Description
button_a function Returns an event when the left side is pressed
button_b function Returns an event when the right side is pressed
button_a_end function Returns an event when the left side is no longer pressed
button_b_end function Returns an event when the right side is no longer pressed
stop stop Stops playing the song
Represents gamescene (all functions in this type are made to be used with on())
Type:
  • object