# Table of Contents

- [Initial page | zarscript2](#initial-page-zarscript2)
- [Script loading | zarscript2](#script-loading-zarscript2)
- [Loaded players | zarscript2](#loaded-players-zarscript2)
- [Events | zarscript2](#events-zarscript2)
- [Module | zarscript2](#module-zarscript2)
- [Examples | zarscript2](#examples-zarscript2)
- [Bow yourself | zarscript2](#bow-yourself-zarscript2)
- [Time counter | zarscript2](#time-counter-zarscript2)
- [API Libs | zarscript2](#api-libs-zarscript2)
- [client | zarscript2](#client-zarscript2)
- [inventory | zarscript2](#inventory-zarscript2)
- [player | zarscript2](#player-zarscript2)
- [world | zarscript2](#world-zarscript2)
- [GUI Events | zarscript2](#gui-events-zarscript2)
- [render | zarscript2](#render-zarscript2)
- [module_manager | zarscript2](#module-manager-zarscript2)
- [http | zarscript2](#http-zarscript2)
- [input | zarscript2](#input-zarscript2)
- [Script loading | zarscript2](#script-loading-zarscript2)
- [Module | zarscript2](#module-zarscript2)

---

# Initial page | zarscript2

[NextScript loading](https://zarzel.gitbook.io/zarscript2/how-to-use-luas/script-loading)

Last updated 4 years ago

Was this helpful?

---

# Script loading | zarscript2

[](https://zarzel.gitbook.io/zarscript2/how-to-use-luas/script-loading#where-to-find-scripts)

Where to find scripts


------------------------------------------------------------------------------------------------------------------------

You can find community made scripts here: [https://www.astolfo.lgbt/forums/forum/27-script-release/](https://www.astolfo.lgbt/forums/forum/27-script-release/)

[](https://zarzel.gitbook.io/zarscript2/how-to-use-luas/script-loading#how-to-install-scripts)

How to install scripts


--------------------------------------------------------------------------------------------------------------------------

To install scripts, you need to go to the Astolfo folder, to do this, send the command ".config folder" in chat.

When you do, there will be a scripts folder, you need to drag the scripts (.lua) in it.

To load them in-game you must do: - 1. ".script reload" - 2. ".script enable <script file name>"

[PreviousInitial page](https://zarzel.gitbook.io/zarscript2)
[NextModule](https://zarzel.gitbook.io/zarscript2/documentation/module)

Last updated 4 years ago

Was this helpful?

---

# Loaded players | zarscript2

This module will print everyone's name on the chat

Copy

    local test = {
        on_pre_update = function()
            local list = world.entities()
    
            for i = 1, #list do
                local entindex = list[i]
                client.print(world.name(entindex))
            end
        end,
    }
    
    module_manager.register('hello', test)

![](https://zarzel.gitbook.io/zarscript2/~gitbook/image?url=https%3A%2F%2F3834947369-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-legacy-files%2Fo%2Fassets%252F-MZF1k85wSNokeus1sCw%252F-MZN8xT90he_wevd0DgV%252F-MZN9gOVcWdlmGFOIsqk%252Fimagen.png%3Falt%3Dmedia%26token%3D24b17a46-7c67-46d4-add4-fe8e23f701c3&width=768&dpr=4&quality=100&sign=92005e4c&sv=2)

Example of output

[PreviousBow yourself](https://zarzel.gitbook.io/zarscript2/documentation/module/examples/bow-yourself)
[NextEvents](https://zarzel.gitbook.io/zarscript2/documentation/module/events)

Last updated 4 years ago

Was this helpful?

---

# Events | zarscript2

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/module/events#on_send_packet)

on\_send\_packet

This event will be called before a packet gets sent to the server.

Key

Type

Description

packet\_id

Number

ID of the packet that is being sent

cancel

Boolean

If the packet should be stopped from sending

This event will also return extra keys in the table depending on the packet. Changing this table values and returning the table means they will be applied

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/module/events#on_receive_packet)

on\_receive\_packet

This event will be called before a packet gets processed in the client.

Key

Type

Description

packet\_id

Number

ID of the packet that is being sent

This event will also return extra keys in the table depending on the packet.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/module/events#on_pre_update)

on\_pre\_update

This event will be called before the local player gets updated

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/module/events#on_post_update)

on\_post\_update

This event will be called after the local player gets updated

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/module/events#on_player_move)

on\_player\_move

This event will be called before the local player movements get processed

Key

Type

Description

x

Number

Motion X of the player

y

Number

Motion Y of the player

z

Number

Motion Z of the player

Changing this table values and returning the table means they will be applied

Example:

Copy

    on_player_move = function(ctx)
       return player.convert_speed(ctx, 2)
    end

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/module/events#on_player_join)

on\_player\_join

This event will be called when the local player is created in the world

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/module/events#on_pre_motion)

on\_pre\_motion

This event will be called before the game sends the position/look packets to the server

Key

Type

Description

x

Number

Pos x of the player

y

Number

Pos y of the player

z

Number

Pos z of the player

yaw

Number

Yaw of the player

pitch

Number

Pitch of the player

on\_ground

Boolean

Player's on ground state

Changing this table values and returning the table means they will be applied

Example:

Copy

    on_pre_motion = function(ctx)
       ctx.pitch = -180
       return ctx
    end

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/module/events#on_post_motion)

on\_post\_motion

This event will be called after the game sends the position/look packets to the server

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/module/events#on_pre_player_input)

on\_pre\_player\_input

This event will be called before the game processes player inputs, basically before moving depending on your yaw, pitch, forward amount and strafe amount

Key

Number

Pos x of the player

strafe

Number

Strafe amount

forward

Number

Forward amount

Changing this table values and returning the table means they will be applied

Changing yaw and pitch on the player on this event, and changing it back to the previous ones in `on_post_player_input`will change the movement as you were looking where you setted the angles in this event.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/module/events#on_post_player_input)

on\_post\_player\_input

This event will be called after the game processes player inputs.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/module/events#on_render_world)

on\_render\_world

This event will be called when the game is rendering the screen

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/module/events#on_render_screen)

on\_render\_screen

This event will be called when the game is rendering the HUD

Key

Type

Description

partial\_ticks

Number

How much time has elapsed since the last tick

width

Number

Width of the Minecraft window

height

Number

Height of the Minecraft Window

scale\_factor

Number

GUI Scaling

mouse\_x

Number

X Mouse coordinates

mouse\_y

Number

Y Mouse coordinates

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/module/events#on_enable)

on\_enable

This event will be called when the module gets enabled

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/module/events#on_disable)

on\_disable

This event will be called when the module gets disabled

[PreviousLoaded players](https://zarzel.gitbook.io/zarscript2/documentation/module/examples/loaded-players)
[NextAPI Libs](https://zarzel.gitbook.io/zarscript2/documentation/api-libs)

Last updated 4 years ago

Was this helpful?

---

# Module | zarscript2

[Examples](https://zarzel.gitbook.io/zarscript2/documentation/module/examples)
[Events](https://zarzel.gitbook.io/zarscript2/documentation/module/events)

[PreviousScript loading](https://zarzel.gitbook.io/zarscript2/how-to-use-luas/script-loading)
[NextExamples](https://zarzel.gitbook.io/zarscript2/documentation/module/examples)

Last updated 4 years ago

Was this helpful?

---

# Examples | zarscript2

[Time counter](https://zarzel.gitbook.io/zarscript2/documentation/module/examples/time-counter)
[Bow yourself](https://zarzel.gitbook.io/zarscript2/documentation/module/examples/bow-yourself)
[Loaded players](https://zarzel.gitbook.io/zarscript2/documentation/module/examples/loaded-players)

[PreviousModule](https://zarzel.gitbook.io/zarscript2/documentation/module)
[NextTime counter](https://zarzel.gitbook.io/zarscript2/documentation/module/examples/time-counter)

Last updated 4 years ago

Was this helpful?

---

# Bow yourself | zarscript2

This module will shoot a bow to yourself silently

Copy

    local ticks = 0
    local doBow = false
    
    local bow = {
        on_enable = function()
            for i = 1, 9 do
                local name = player.inventory.item_information(35 + i)
                if name == "item.bow" then
                    player.send_packet(0x09, i)
                    player.send_packet(0x08, i)
                    ticks = 5
                    doBow = true
                end
            end
        end,
        on_pre_motion = function(t)
            if doBow then
                t.pitch = -88
                if ticks > 0 then
                    ticks = ticks - 1
                else
                    player.send_packet(0x07)
                    player.send_packet(0x09, player.held_item_slot())
                    doBow = false
                end
            end
            return t
        end,
    }
    
    module_manager.register('Bow', bow)

`player.send_packet(0x09, i)` swaps your hand to the bow hotbar slot

`player.send_packet(0x08, i)` starts using the item in that slot

`player.send_packet(0x07)` releases the item

`player.send_packet(0x09, player.held_item_slot())` switches back to the item you actually have on hand

[PreviousTime counter](https://zarzel.gitbook.io/zarscript2/documentation/module/examples/time-counter)
[NextLoaded players](https://zarzel.gitbook.io/zarscript2/documentation/module/examples/loaded-players)

Last updated 4 years ago

Was this helpful?

---

# Time counter | zarscript2

This module will count the time it has passed since you joined a world with a new account

Copy

    local prev_player_name = ""
    local time = 0
    
    local time_counter = {
        on_render_screen = function(ctx)
            if (player.name() ~= prev_player_name) then
                time = client.time()
                prev_player_name = player.name()
            end
    
            local diff = client.time() - time;
            if (diff > 0) then
                local diff_seconds = diff / 1000 % 60;
                local diff_minutes = diff / (60 * 1000) % 60;
                local diff_hours = diff / (60 * 60 * 1000) % 24;
    
                local string = math.floor(diff_hours) .. "h " .. math.floor(diff_minutes) .. "m " .. math.floor(diff_seconds) .. "s";
                render.string(string, ctx.width / 2 - render.get_string_width(string) / 2, 30, 255, 255, 255, 255)
            end
        end,
    }
    
    module_manager.register('TimeCounter', time_counter)

[PreviousExamples](https://zarzel.gitbook.io/zarscript2/documentation/module/examples)
[NextBow yourself](https://zarzel.gitbook.io/zarscript2/documentation/module/examples/bow-yourself)

Last updated 4 years ago

Was this helpful?

---

# API Libs | zarscript2

[player](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player)
[world](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world)
[client](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/client)
[render](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render)
[module\_manager](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/module_manager)
[input](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/input)
[http](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/http)

[PreviousEvents](https://zarzel.gitbook.io/zarscript2/documentation/module/events)
[Nextplayer](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player)

Last updated 4 years ago

Was this helpful?

---

# client | zarscript2

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/client#client.gui_name)

client.gui\_name

Copy

    client.gui_name(): string

Returns the name of the gui the player is in right now

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/client#client.time)

client.time

Copy

    client.time(): number

Returns the system time in milliseconds

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/client#client.config)

client.config

Copy

    client.config(): string

Returns the current config name

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/client#client.print)

client.print

Copy

    client.print(chat_message)

Argument

Type

Description

chat\_message

String

Message

Prints the desired message in chat

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/client#client.title)

client.title

Copy

    client.title(): string

Returns the current title that is showing up on the screen.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/client#client.subtitle)

client.subtitle

Copy

    client.subtitle(): string

Returns the current title that is showing up on the screen.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/client#client.chest_name)

client.chest\_name

Copy

    client.chest_name(): string

Returns the current chest display name.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/client#client.fps)

client.fps

Copy

    client.fps(): number

Returns the FPS the game is running at the moment

[Previousworld](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world)
[Nextrender](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render)

Last updated 4 years ago

Was this helpful?

---

# inventory | zarscript2

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player/inventory#player.inventory.slot)

player.inventory.slot

Copy

    player.inventory.slot(slot_id): string

Argument

Type

Description

slot\_id

Number

ID of the slot to check

Returns the name of the item in the slot

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player/inventory#player.inventory.item_information)

player.inventory.item\_information

Copy

    player.inventory.item_information(slot_id): string, string, number, number, table

Argument

Type

Description

slot\_id

Number

ID of the slot to check

Returns item name, display name, item damage, efficiency and a table containing all enchants

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player/inventory#player.inventory.swap)

player.inventory.swap

Copy

    player.inventory.swap(slot_id, hotbar_slot)

Argument

Type

Description

slot\_id

Number

ID of the slot to swap

hotbar\_slot

Number

Hotbar slot number where the item will be set at

Moves an item to your hotbar

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player/inventory#player.inventory.click)

player.inventory.click

Copy

    player.inventory.click(slot_id, mouse_click, mode)

Argument

Type

Description

slot\_id

Number

ID of the slot to swap

mouse\_click

Number

Mouse click

mode

Number

1: to hold click 0: to normal click

4: to drop item

Clicks an item in your inventory or chest

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player/inventory#player.inventory.drop)

player.inventory.drop

Copy

    player.inventory.drop(slot_id)

Argument

Type

Description

slot\_id

Number

ID of the slot to drop

Drops an item in your inventory

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player/inventory#player.inventory.get_item_stack)

player.inventory.get\_item\_stack

Copy

    player.inventory.get_item_stack(slot_id): number

Argument

Type

Description

slot\_id

Number

ID of the slot

Returns the amount of items in the desired slot

[Previousplayer](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player)
[Nextworld](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world)

Last updated 4 years ago

Was this helpful?

---

# player | zarscript2

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.jump)

player.jump

Copy

    player.jump()

Makes the local player jump

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.click_mouse)

player.click\_mouse

Copy

    player.click_mouse()

Left clicks

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.right_click_mouse)

player.right\_click\_mouse

Copy

    player.right_click_mouse()

Right clicks

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.message)

player.message

Copy

    player.message(message)

Argument

Type

Description

message

String

Message

Sends a message in chat, can also run client commands such as ".killaura" to toggle modules or set any option.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.strafe)

player.strafe

Copy

    player.strafe(): number, number

Returns the forward and strafing speed the player is moving at

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.position)

player.position

Copy

    player.position(): number, number, number

Returns the player's x, y and z positions.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.camera_position)

player.camera\_position

Copy

    player.camera_position(): number, number, number

Returns the camera's x, y and z positions.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.prev_position)

player.prev\_position

Copy

    player.prev_position(): number, number, number

Returns the player's previous x, y and z positions.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.motion)

player.motion

Copy

    player.motion(): number, number, number

Returns the player's x, y and z motion amount.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.set_motion)

player.set\_motion

Copy

    player.set_motion(motion_x, motion_y, motion_z)

Argument

Type

Description

motion\_x

Number

New motion x value

motion\_y

Number

New motion y value

motion\_z

Number

New motion z value

Sets the local player motion

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.set_position)

player.set\_position

Copy

    player.set_position(pos_x, pos_y, pos_z)

Argument

Type

Description

pos\_x

Number

New player position x

pos\_y

Number

New player position y

pos\_z

Number

New player position z

Sets the local player position

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.set_sprinting)

player.set\_sprinting

Copy

    player.set_sprinting(sprinting)

Argument

Type

Description

sprinting

boolean

Player sprinting state

Sets local player's sprinting state

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.distance_to_entity)

player.distance\_to\_entity

Copy

    player.distance_to_entity(entity_id): number

Argument

Type

Description

entity\_id

number

ID of the entity

Returns the distance in blocks between you and the entity.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.distance_to)

player.distance\_to

Copy

    player.distance_to(pos_x, pos_y, pos_z): number

Argument

Type

Description

pos\_x

Number

pos x

pos\_y

Number

pos y

pos\_z

Number

pos z

Returns the distance in blocks between you and the coordinates.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.send_packet)

player.send\_packet

Copy

    player.send_packet(packet_id, [...])

Argument

Type

Description

packet\_id

Number

Packet ID

Sends a packet to the server.

Packet IDs can be found here: [https://wiki.vg/index.php?title=Protocol&oldid=7368#Serverbound\_2](https://wiki.vg/index.php?title=Protocol&oldid=7368#Serverbound_2)

Packets supported: 0x0A, 0x07, 0x08, 0x0B, 0x03, 0x04, 0x05, 0x06, 0x07, 0x0F

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.angles)

player.angles

Copy

    player.angles(): number, number

Returns yaw and pitch.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.prev_angles)

player.prev\_angles

Copy

    player.prev_angles(): number, number

Returns prev yaw and prev pitch.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.set_angles)

player.set\_angles

Copy

    player.set_angles(yaw, pitch)

Argument

Type

Description

yaw

Number

new yaw

pitch

Number

new pitch

Sets the player in-game look angles

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.using_item)

player.using\_item

Copy

    player.using_item(): boolean

Returns if the player is using an item or not.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.swing_item)

player.swing\_item

Copy

    player.swing_item()

Swings the item

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.use_item)

player.use\_item

Copy

    player.use_item()

Uses the item you're holding

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.id)

player.id

Copy

    player.id(): number

Returns your current player entity ID

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.health)

player.health

Copy

    player.health(): number

Returns your current player health, divide by two for getting heart amount

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.fall_distance)

player.fall\_distance

Copy

    player.fall_distance(): number

Returns the amount of blocks you're falling

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.max_health)

player.max\_health

Copy

    player.max_health(): number

Returns the max amount of health your player can have, divide by two for getting hearts

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.held_item)

player.held\_item

Copy

    player.held_item(): string

Returns the name of the item you're holding

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.name)

player.name

Copy

    player.name(): string

Returns the player name

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.base_speed)

player.base\_speed

Copy

    player.base_speed(): number

Returns the base speed amount, used for speed calculations.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.held_item_slot)

player.held\_item\_slot

Copy

    player.held_item_slot(): number

Returns the slot number of the item you're holding. Counting from 1 to 9

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.set_held_item_slot)

player.set\_held\_item\_slot

Copy

    player.set_held_item_slot(slot)

Argument

Type

Description

slot

Number

New hotbar slot

Sets your hotbar slot to the desired one

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.hurt_time)

player.hurt\_time

Copy

    player.hurt_time(): number

Returns how much ticks of hurt time left

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.food_stats)

player.food\_stats

Copy

    player.food_stats(): number

Returns the hunger you have, divide by two to get muslito amount

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.absorption)

player.absorption

Copy

    player.absorption(): number

Returns amount of yellow health that you have, divide by two to get heart amount

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.eye_height)

player.eye\_height

Copy

    player.eye_height(): number

Returns

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.facing)

player.facing

Copy

    player.facing(): number

This function will return a direction on a number.

1: Down 2: Up 3: North 4: South 5: West 6: East

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.over_mouse)

player.over\_mouse

Copy

    player.over_mouse(): number, [...]

This function will return different values depending on the first returned number.

If the first number is 1, this means your player is not aiming at anything. If the number is 3, this means its aiming at an entity, second number will return the index of that entity If the number is 2, this means its aiming at a block, will return `side_hit, block_x, block_x, block_x, hit_x, hit_y, hit_z`

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.convert_speed)

player.convert\_speed

Copy

    player.convert_speed(on_player_move_table, speed): [fixed_table]

Argument

Type

Description

table

Table

The table that `on_player_move`gives you

speed

Number

Speed amount, player.base\_speed() is used here

This function will return a table that sets the `on_player_move` table values to ones that will make the player strafe according to the speed assigned

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.kill_aura_target)

player.kill\_aura\_target

Copy

    player.kill_aura_target(): number

Returns the player id of KillAura's target

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.on_ground)

player.on\_ground

Copy

    player.on_ground(): boolean

Returns if the player is on the ground

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.is_in_water)

player.is\_in\_water

Copy

    player.is_in_water(): boolean

Returns if the player is in water

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.is_in_lava)

player.is\_in\_lava

Copy

    player.is_in_lava(): boolean

Returns if the player is in lava

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.burning)

player.burning

Copy

    player.burning(): boolean

Returns if the player is currently burning

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.is_sneaking)

player.is\_sneaking

Copy

    player.is_sneaking(): boolean

Returns if the player is currently sneaking

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.set_sneaking)

player.set\_sneaking

Copy

    player.set_sneaking(sneak)

Argument

Type

Description

sneak

boolean

Sneak

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.is_in_cobweb)

player.is\_in\_cobweb

Copy

    player.is_in_cobweb(): boolean

Returns if the player is currently in a cobweb

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.angles_for_cords)

player.angles\_for\_cords

Copy

    player.angles_for_cords(x, y, z): number, number

Argument

Type

Description

x

Number

x position

y

Number

y position

z

Number

z position

This function returns a yaw and pitch to look at the desired coordinates.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.dead)

player.dead

Copy

    player.dead(): boolean

Returns if the player is currently dead

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.sprinting)

player.sprinting

Copy

    player.sprinting(): boolean

Returns if the player is currently sprinting

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.riding)

player.riding

Copy

    player.riding(): boolean

Returns if the player is currently riding an entity

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.on_ladder)

player.on\_ladder

Copy

    player.on_ladder(): boolean

Returns if the player is currently on a ladder

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.collided_vertically)

player.collided\_vertically

Copy

    player.collided_vertically(): boolean

Returns if the player is currently colliding with any block vertically

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.collided_horizontally)

player.collided\_horizontally

Copy

    player.collided_horizontally(): boolean

Returns if the player is currently colliding with any block horizontally

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.is_potion_active)

player.is\_potion\_active

Copy

    player.is_potion_active(potion_id): boolean

Argument

Type

Description

potion\_id

Number

ID of the potion to check

Returns if the desired potion is currently active

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.ticks_existed)

player.ticks\_existed

Copy

    player.ticks_existed(): number

Returns the amount of ticks the player has existed in the world

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.ray_cast)

player.ray\_cast

Copy

    player.ray_cast(yaw, pitch, range): number, [...]

Argument

Type

Description

yaw

Number

Yaw to simulate

pitch

Number

Pitch to simulate

range

Number

Amount of blocks

This function will return different values depending on the first returned number.

If the first number is 1, this means your player is not aiming at anything. If the number is 3, this means its aiming at an entity, second number will return the index of that entity If the number is 2, this means its aiming at a block, will return `side_hit, block_x, block_x, block_x, hit_x, hit_y, hit_z`

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.place_block)

player.place\_block

Copy

    player.place_block(item_slot, block_x, block_y, block_z, side, hit_x, hit_y, hit_z): boolean

Argument

Type

Description

item\_slot

Number

Number of the slot of the block you're trying to place (must be held in hand)

block\_x

Number

X coordinate of the block

block\_y

Number

Y coordinate of the block

block\_z

Number

Z coordinate of the block

side

Number

Index of the facing value

`hit_x` , `hit_y`and `hit_z`are values used to check where the actual placement took place, this are the values sent to the server in the 0x08 packet

Copy

    local facing_x = hit_x - block_x
    local facing_y = hit_y - block_y
    local facing_y = hit_z - block_z

This means that the hit\_\* values you'll put in the function will be applied to the example shown before

Places a block

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.is_on_edge)

player.is\_on\_edge

Copy

    player.is_on_edge(): boolean

Returns if the player is at the edge of a block

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.get_speed)

player.get\_speed

Copy

    player.get_speed(): number

Returns the players speed

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player#player.set_speed)

player.set\_speed

Copy

    player.set_speed(speed): number

Argument

Type

Description

speed

Number

Amount of speed

Sets the player's speed

[PreviousAPI Libs](https://zarzel.gitbook.io/zarscript2/documentation/api-libs)
[Nextinventory](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player/inventory)

Last updated 4 years ago

Was this helpful?

---

# world | zarscript2

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.timer)

world.timer

Copy

    world.timer(): number

Returns the multiplier of speed the game is running at.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.set_timer)

world.set\_timer

Copy

    world.set_timer(timer_speed)

Argument

Type

Description

timer\_speed

Number

Timer speed

Sets the multiplier to make the speed faster or slower, 0.5 makes the game run at half-speed

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.refresh_chunks)

world.refresh\_chunks

Copy

    world.refresh_chunks()

Refreshes the loaded chunks, just like F3+A does

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.entities)

world.entities

Copy

    world.entities(): table

Returns a table with all the loaded entities IDs

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.block)

world.block

Copy

    world.block(x, y, z): string

Argument

Type

Description

x

Number

x position

y

Number

y position

z

Number

z position

Returns the name of the block in the specified cords

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.name)

world.name

Copy

    world.name(entity_id): string

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns the name of the specified entity

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.display_name)

world.display\_name

Copy

    world.display_name(entity_id): string

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns the display name of the specified entity, example: \[MVP++\] Player

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.held_item)

world.held\_item

Copy

    world.held_item(entity_id): string

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns the name of the item the player is holding

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.hurt_time)

world.hurt\_time

Copy

    world.hurt_time(entity_id): number

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns how much ticks of hurt time the player has left

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.health)

world.health

Copy

    world.health(entity_id): number

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns the player health, divide by two for getting heart amount

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.max_health)

world.max\_health

Copy

    world.max_health(entity_id): number

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns the player max health, divide by two for getting heart amount

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.sprinting)

world.sprinting

Copy

    world.sprinting(entity_id): boolean

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns if the player is sprinting

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.facing)

world.facing

Copy

    world.facing(entity_id): number

Argument

Type

Description

entity\_id

Number

ID of the entity

This function will return a direction on a number

1: Down 2: Up 3: North 4: South 5: West 6: East

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.angles)

world.angles

Copy

    world.angles(entity_id): number, number

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns the player's yaw and pitch

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.bounding_box)

world.bounding\_box

Copy

    world.bounding_box(entity_id): number, number, number, number, number, number

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns minX, minY, minZ, maxX, maxY, maxZ of the players BBOX

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.ticks_existed)

world.ticks\_existed

Copy

    world.ticks_existed(entity_id): number

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns the ticks the player has existed in the world

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.is_player)

world.is\_player

Copy

    world.is_player(entity_id): boolean

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns if the entity is a player

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.width_height)

world.width\_height

Copy

    world.width_height(entity_id): number, number

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns the entity width and height

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.is_sneaking)

world.is\_sneaking

Copy

    world.is_sneaking(entity_id): boolean

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns if the entity is sneaking

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.is_invisible)

world.is\_invisible

Copy

    world.is_invisible(entity_id): boolean

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns if the entity is invisible

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.burning)

world.burning

Copy

    world.burning(entity_id): boolean

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns if the entity is burning

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.is_bot)

world.is\_bot

Copy

    world.is_bot(entity_id): boolean

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns if the entity is detected as a bot by the client

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.is_friend)

world.is\_friend

Copy

    world.is_friend(entity_id): boolean

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns if the entity is a friend in the client

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.is_enemy)

world.is\_enemy

Copy

    world.is_enemy(entity_id): boolean

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns if the entity is an enemy in the client

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.riding)

world.riding

Copy

    world.riding(entity_id): boolean

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns if the entity is riding anything

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.position)

world.position

Copy

    world.position(entity_id): number, number, number

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns the player's x, y and z positions

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.prev_position)

world.prev\_position

Copy

    world.prev_position(entity_id): number, number, number

Argument

Type

Description

entity\_id

Number

ID of the entity

Returns the previous player's x, y and z positions

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.is_potion_active)

world.is\_potion\_active

Copy

    world.is_potion_active(entity_id, potion_id): boolean

Argument

Type

Description

entity\_id

Number

ID of the entity

potion\_id

Number

ID of the potion to check if active

Returns if the player has the specified potion id active

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.remove)

world.remove

Copy

    world.remove(entity_id): boolean

Argument

Type

Description

entity\_id

Number

ID of the entity

Removes the entity from the world, will return true if successfully removed

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.biome)

world.biome

Copy

    world.biome(): string

Returns the current biome name

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/world#world.inventory)

world.inventory

Copy

    world.inventory(): table

Returns the player's inventory in a table, table.helmet, table.chestplate, table.leggings, table.boots, table.hand

[Previousinventory](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/player/inventory)
[Nextclient](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/client)

Last updated 4 years ago

Was this helpful?

---

# GUI Events | zarscript2

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render/gui-events#on_render_screen)

on\_render\_screen

This event will be called when the GUI screen is being rendered

Key

Type

Description

mouse\_x

Number

X Mouse coordinates

mouse\_y

Number

Y Mouse coordinates

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render/gui-events#on_click)

on\_click

This event will be called when a mouse button is pressed in the GUI

Key

Type

Description

mouse\_x

Number

X Mouse coordinates

mouse\_y

Number

Y Mouse coordinates

mouse\_button

Number

ID of the mouse button clicked

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render/gui-events#on_drag_click)

on\_drag\_click

This event will be called when the mouse is being hold and dragged around

Key

Type

Description

mouse\_x

Number

X Mouse coordinates

mouse\_y

Number

Y Mouse coordinates

mouse\_button

Number

ID of the mouse button clicked

time\_since

Number

Time since the mouse click has happened

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render/gui-events#on_mouse_released)

on\_mouse\_released

This event will be called when a mouse button is released

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render/gui-events#on_key_typed)

on\_key\_typed

This event will be called when a key is pressed on the keyboard

Key

Type

Description

typed\_char

Character

Character pressed

key\_code

Number

Code of the pressed key

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render/gui-events#on_gui_close)

on\_gui\_close

This event will be called when the GUI is closed

[Previousrender](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render)
[Nextmodule\_manager](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/module_manager)

Last updated 4 years ago

Was this helpful?

---

# render | zarscript2

All of this functions must be run on this event for them to work

[https://zarzel.gitbook.io/zarscript2/documentation/module/events#on\_render\_screen](https://zarzel.gitbook.io/zarscript2/documentation/module/events#on_render_screen)

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render#render.rect)

render.rect

Copy

    render.rect(x, y, x1, y1, r, g, b, a)

Argument

Type

Description

x

Number

X pos

y

Number

Y pos

x1

Number

End X pos

y1

Number

End Y pos

r

Number

Red 0-255

g

Number

Green 0-255

b

Number

Blue 0-255

a

Number

Alpha 0-255

Draws a filled rect on the screen

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render#render.line)

render.line

Copy

    render.line(x, y, x1, y1, size, r, g, b, a)

Argument

Type

Description

x

Number

X pos

y

Number

Y pos

x1

Number

End X pos

y1

Number

End Y pos

size

Number

Line size

r

Number

Red 0-255

g

Number

Green 0-255

b

Number

Blue 0-255

a

Number

Alpha 0-255

Draws a line on the screen

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render#render.player_head)

render.player\_head

Copy

    render.player_head(x, y, size, entity_id)

Argument

Type

Description

x

Number

X pos

y

Number

Y pos

size

Number

Size of the player's head

entity\_id

Number

ID of the entity to draw

Draws the player's skin head

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render#render.circle)

render.circle

Copy

    render.circle(x, y, degrees, rotation, diameter, r, g, b, a)

Argument

Type

Description

x

Number

X pos

y

Number

Y pos

degrees

Number

Degrees of the circle

rotation

Number

Rotation of the circle

diameter

Number

Circle size

r

Number

Red 0-255

g

Number

Green 0-255

b

Number

Blue 0-255

a

Number

Alpha 0-255

Renders a circle on your screen.

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render#render.player)

render.player

Copy

    render.player(x, y, size, yaw, pitch, entity_id)

Argument

Type

Description

x

Number

X pos

y

Number

Y pos

size

Number

How big will the player be

yaw

Number

Yaw where the player will be looking

pitch

Number

Pitch where the player will be looking

entity\_id

Number

ID of the entity to draw

Renders the full player on the screen

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render#render.string)

render.string

Copy

    render.string(text, x, y, r, g, b, a)

Argument

Type

Description

text

String

Text to render

x

Number

X pos

y

Number

Y pos

r

Number

Red 0-255

g

Number

Green 0-255

b

Number

Blue 0-255

a

Number

Alpha 0-255

Renders text on your screen

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render#render.string_shadow)

render.string\_shadow

Copy

    render.string_shadow(text, x, y, r, g, b, a)

Argument

Type

Description

text

String

Text to render

x

Number

X pos

y

Number

Y pos

r

Number

Red 0-255

g

Number

Green 0-255

b

Number

Blue 0-255

a

Number

Alpha 0-255

Renders text with shadow on your screen

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render#render.get_string_width)

render.get\_string\_width

Copy

    render.get_string_width(text): number

Argument

Type

Description

text

String

Text

Returns the width of the specified text

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render#render.scale)

render.scale

Copy

    render.scale(scaling)

Argument

Type

Description

scaling

Number

Scale multiplier

Scales the next drawing functions, for example, 2 multiplier will make the drawings twice as big

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render#render.world_to_screen)

render.world\_to\_screen

Copy

    render.world_to_screen(x, y, z): number, number, number

Argument

Type

Description

x

Number

X position

y

Number

Y position

z

Number

Z position

Returns the screen position of the desired coordinates

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render#render.show_gui)

render.show\_gui

Copy

    render.show_gui(gui_table)

Argument

Type

Description

gui\_table

Table

Table containing all the gui functions

This function is similar to the `module_manager.register` function, but instead of registering anything, it displays a custom GUI you can make. Further information for the events here

[GUI Events](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render/gui-events)

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render#render.draw_image)

render.draw\_image

Copy

    render.draw_image(url, x, y, width height)

Argument

Type

Description

url

String

URL where the image is located

x

Number

X position

y

Number

Y position

width

Number

Width of image display

height

Number

Height of image display

Draws the image thats contained in the URL, for this method to work you must have enabled unsafe script functionality

[Previousclient](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/client)
[NextGUI Events](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render/gui-events)

Last updated 4 years ago

Was this helpful?

---

# module_manager | zarscript2

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/module_manager#module_manager.register)

module\_manager.register

Copy

    module_manager.register(module_name, module_table)

Argument

Type

Description

module\_name

String

Module name

module\_table

Table

Module table

Register a module in the client

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/module_manager#module_manager.register_boolean)

module\_manager.register\_boolean

Copy

    module_manager.register_boolean(module_name, option_name, default_state)

Argument

Type

Description

module\_name

String

Module name

option\_name

String

The name of the option

default\_state

Boolean

The default state of the option

Register a boolean option in a module

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/module_manager#module_manager.register_number)

module\_manager.register\_number

Copy

    module_manager.register_number(module_name, option_name, min_value, max_value, current_value)

Argument

Type

Description

module\_name

String

Module name

option\_name

String

The name of the option

min\_value

Number

The min value of the number option

max\_value

Number

The max value of the number option

current\_value

Number

The default value of the option

Register a number option in a module

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/module_manager#module_manager.is_module_on)

module\_manager.is\_module\_on

Copy

    module_manager.is_module_on(module_name): boolean

Argument

Type

Description

module\_name

String

Module name (case-sensitive)

Returns if the specified module is currently active

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/module_manager#module_manager.option)

module\_manager.option

Copy

    module_manager.option(module_name, module_option, [...]): [...]

Argument

Type

Description

module\_name

String

Module name (case-sensitive)

module\_option

String

Option name (case-sensitive)

\[...\]

String

Used for getting options in sub options

Returns the value of the specified option

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/module_manager#module_manager.set_option)

module\_manager.set\_option

Copy

    module_manager.set_option(module_name, module_option, [...], [...])

Argument

Type

Description

module\_name

String

Module name (case-sensitive)

module\_option

String

Option name (case-sensitive)

\[...\]

String

Used for getting options in sub options

\[...\]

String/boolean/number

New value of the option

Sets a new value to the desired option

[PreviousGUI Events](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/render/gui-events)
[Nextinput](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/input)

Last updated 4 years ago

Was this helpful?

---

# http | zarscript2

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/http#http.get)

http.get

Copy

    http.get(url): string

Argument

Type

Description

url

String

URL to request to

Returns the response of the website

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/http#http.get_async)

http.get\_async

Copy

    http.get_async(url, method)

Argument

Type

Description

url

String

URL to request to

method

Table

Table containing the method that will be ran once the request is completed

This method wont hang the game while the request doesnt have a response

Copy

    http.get_async("https://google.com", {
      run = function(text)
            client.print(text)
      end
    })

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/http#http.post)

http.post

Copy

    http.post(url): string

Argument

Type

Description

url

String

URL to request to, containing parameters

Returns the response of the website

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/http#http.post_async)

http.post\_async

Copy

    http.post_async(url, method)

Argument

Type

Description

url

String

URL to request to, containing parameters

method

Table

Table containing the method that will be ran once the request is completed

This method wont hang the game while the request doesnt have a response

Copy

    http.post_async("https://google.com", {
      run = function(text)
            client.print(text)
      end
    })

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/http#http.load)

http.load

Copy

    http.load(url): <?>

Argument

Type

Description

url

String

URL where the Lua code is

This method will load the code inside the specified URL into the script context

Copy

    json = (http.load("http://regex.info/code/JSON.lua")())

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/http#undefined)

[Previousinput](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/input)

Last updated 4 years ago

Was this helpful?

---

# input | zarscript2

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/input#input.is_key_down)

input.is\_key\_down

Copy

    input.is_key_down(key_code): boolean

Argument

Type

Description

key\_code

Number

LWJGL 2 Key code to check

Returns if the specified key is currently being pressed

Key codes can be found here: [https://minecraft.fandom.com/el/wiki/Key\_codes](https://minecraft.fandom.com/el/wiki/Key_codes)

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/input#input.is_mouse_down)

input.is\_mouse\_down

Copy

    input.is_mouse_down(mouse_button): boolean

Argument

Type

Description

mouse\_button

Number

LWJGL 2 mouse button code to check

Returns if the specified mouse button is currently being pressed

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/input#input.get_key_name)

input.get\_key\_name

Copy

    input.get_key_name(key_code): string

Argument

Type

Description

key\_code

Number

Key code

Returns the key name of a specified key code

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/input#input.get_key_number)

input.get\_key\_number

Copy

    input.get_key_name(key_name): number

Argument

Type

Description

key\_name

String

Key name, such as "b"

Returns the key code of the specified key name

### 

[](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/input#input.get_scroll)

input.get\_scroll

Copy

    input.get_scroll(): number

Returns the scrolled amount in mouse wheel

[Previousmodule\_manager](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/module_manager)
[Nexthttp](https://zarzel.gitbook.io/zarscript2/documentation/api-libs/http)

Last updated 4 years ago

Was this helpful?

---

# Script loading | zarscript2

[](https://zarzel.gitbook.io/zarscript2/how-to-use-luas#where-to-find-scripts)

Where to find scripts


---------------------------------------------------------------------------------------------------------

You can find community made scripts here: [https://www.astolfo.lgbt/forums/forum/27-script-release/](https://www.astolfo.lgbt/forums/forum/27-script-release/)

[](https://zarzel.gitbook.io/zarscript2/how-to-use-luas#how-to-install-scripts)

How to install scripts


-----------------------------------------------------------------------------------------------------------

To install scripts, you need to go to the Astolfo folder, to do this, send the command ".config folder" in chat.

When you do, there will be a scripts folder, you need to drag the scripts (.lua) in it.

To load them in-game you must do: - 1. ".script reload" - 2. ".script enable <script file name>"

[PreviousInitial page](https://zarzel.gitbook.io/zarscript2)
[NextModule](https://zarzel.gitbook.io/zarscript2/documentation/module)

Last updated 4 years ago

Was this helpful?

---

# Module | zarscript2

[Examples](https://zarzel.gitbook.io/zarscript2/documentation/module/examples)
[Events](https://zarzel.gitbook.io/zarscript2/documentation/module/events)

[PreviousScript loading](https://zarzel.gitbook.io/zarscript2/how-to-use-luas/script-loading)
[NextExamples](https://zarzel.gitbook.io/zarscript2/documentation/module/examples)

Last updated 4 years ago

Was this helpful?

---