# Table of Contents - [Introduction | Rise 6 Scripting API](#introduction-rise-6-scripting-api) - [Introduction | Rise 6 Scripting API](#introduction-rise-6-scripting-api) - [Simple vanilla hop | Rise 6 Scripting API](#simple-vanilla-hop-rise-6-scripting-api) - [Simple collide fly bypass | Rise 6 Scripting API](#simple-collide-fly-bypass-rise-6-scripting-api) - [Exempted value speed bypass | Rise 6 Scripting API](#exempted-value-speed-bypass-rise-6-scripting-api) - [Events example | Rise 6 Scripting API](#events-example-rise-6-scripting-api) - [Example settings | Rise 6 Scripting API](#example-settings-rise-6-scripting-api) - [BlockPos | Rise 6 Scripting API](#blockpos-rise-6-scripting-api) - [Packet nofall | Rise 6 Scripting API](#packet-nofall-rise-6-scripting-api) - [Killaura | Rise 6 Scripting API](#killaura-rise-6-scripting-api) - [Arraylist | Rise 6 Scripting API](#arraylist-rise-6-scripting-api) - [Objects | Rise 6 Scripting API](#objects-rise-6-scripting-api) - [Global namespaces | Rise 6 Scripting API](#global-namespaces-rise-6-scripting-api) - [Vector | Rise 6 Scripting API](#vector-rise-6-scripting-api) - [Scripting metadata | Rise 6 Scripting API](#scripting-metadata-rise-6-scripting-api) - [Entity | Rise 6 Scripting API](#entity-rise-6-scripting-api) - [FontRenderer | Rise 6 Scripting API](#fontrenderer-rise-6-scripting-api) - [Vector3 | Rise 6 Scripting API](#vector3-rise-6-scripting-api) - [render | Rise 6 Scripting API](#render-rise-6-scripting-api) - [ItemStack | Rise 6 Scripting API](#itemstack-rise-6-scripting-api) - [Vector2 | Rise 6 Scripting API](#vector2-rise-6-scripting-api) - [Inventory | Rise 6 Scripting API](#inventory-rise-6-scripting-api) - [Block | Rise 6 Scripting API](#block-rise-6-scripting-api) - [Command | Rise 6 Scripting API](#command-rise-6-scripting-api) - [Module | Rise 6 Scripting API](#module-rise-6-scripting-api) - [Load event | Rise 6 Scripting API](#load-event-rise-6-scripting-api) - [Events | Rise 6 Scripting API](#events-rise-6-scripting-api) - [Unload event | Rise 6 Scripting API](#unload-event-rise-6-scripting-api) - [network | Rise 6 Scripting API](#network-rise-6-scripting-api) - [input | Rise 6 Scripting API](#input-rise-6-scripting-api) - [EntityLiving | Rise 6 Scripting API](#entityliving-rise-6-scripting-api) - [mc | Rise 6 Scripting API](#mc-rise-6-scripting-api) - [world | Rise 6 Scripting API](#world-rise-6-scripting-api) - [rise | Rise 6 Scripting API](#rise-rise-6-scripting-api) - [packet | Rise 6 Scripting API](#packet-rise-6-scripting-api) - [Server Kick event | Rise 6 Scripting API](#server-kick-event-rise-6-scripting-api) - [Attack event | Rise 6 Scripting API](#attack-event-rise-6-scripting-api) - [onExecute event | Rise 6 Scripting API](#onexecute-event-rise-6-scripting-api) - [Module Toggle Event | Rise 6 Scripting API](#module-toggle-event-rise-6-scripting-api) - [player | Rise 6 Scripting API](#player-rise-6-scripting-api) - [Game event | Rise 6 Scripting API](#game-event-rise-6-scripting-api) - [Module events | Rise 6 Scripting API](#module-events-rise-6-scripting-api) - [World Change Event | Rise 6 Scripting API](#world-change-event-rise-6-scripting-api) - [Chat input event | Rise 6 Scripting API](#chat-input-event-rise-6-scripting-api) - [Click event | Rise 6 Scripting API](#click-event-rise-6-scripting-api) - [Post motion event | Rise 6 Scripting API](#post-motion-event-rise-6-scripting-api) - [Keyboard Input event | Rise 6 Scripting API](#keyboard-input-event-rise-6-scripting-api) - [Kill event | Rise 6 Scripting API](#kill-event-rise-6-scripting-api) - [Entity render event | Rise 6 Scripting API](#entity-render-event-rise-6-scripting-api) - [Pre update event | Rise 6 Scripting API](#pre-update-event-rise-6-scripting-api) - [Hit slow down event | Rise 6 Scripting API](#hit-slow-down-event-rise-6-scripting-api) - [Jump event | Rise 6 Scripting API](#jump-event-rise-6-scripting-api) - [Tick event | Rise 6 Scripting API](#tick-event-rise-6-scripting-api) - [Move input event | Rise 6 Scripting API](#move-input-event-rise-6-scripting-api) - [Strafe event | Rise 6 Scripting API](#strafe-event-rise-6-scripting-api) - [Pre motion event | Rise 6 Scripting API](#pre-motion-event-rise-6-scripting-api) - [Render 2D event | Rise 6 Scripting API](#render-2d-event-rise-6-scripting-api) - [Slow down event | Rise 6 Scripting API](#slow-down-event-rise-6-scripting-api) - [Water event | Rise 6 Scripting API](#water-event-rise-6-scripting-api) - [Render 3D event | Rise 6 Scripting API](#render-3d-event-rise-6-scripting-api) --- # Introduction | Rise 6 Scripting API Welcome to the Rise 6 Scripting API documentation. This document goes over the API itself, as well as some examples**.** circle-info The scripting system uses Java Script (ES version **5**.1) as the scripting language. circle-exclamation Script throwing an exception could result in the script being unloaded. circle-exclamation You **should** unregister/finalize modules/commands/anything else manually. This is not required, however is strongly suggested in case of a script crash. triangle-exclamation **Disabling** security measures feature will allow Java.type() access **for every class, including the classes from Java standard library**, bringing a possibility to run unsafe code. Those measures are enabled by default. To switch their state, do .script enablesecurity or .script disablesecurity [NextSimple vanilla hopchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/examples/simple-vanilla-hop) --- # Introduction | Rise 6 Scripting API Welcome to the Rise 6 Scripting API documentation. This document goes over the API itself, as well as some examples**.** circle-info The scripting system uses Java Script (ES version **5**.1) as the scripting language. circle-exclamation Script throwing an exception could result in the script being unloaded. circle-exclamation You **should** unregister/finalize modules/commands/anything else manually. This is not required, however is strongly suggested in case of a script crash. triangle-exclamation **Disabling** security measures feature will allow Java.type() access **for every class, including the classes from Java standard library**, bringing a possibility to run unsafe code. Those measures are enabled by default. To switch their state, do .script enablesecurity or .script disablesecurity [NextSimple vanilla hopchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/examples/simple-vanilla-hop) --- # Simple vanilla hop | Rise 6 Scripting API Copy var module = rise.registerModule("VHop", "Simple vanilla hop speed.") script.handle("onUnload", function () { module.unregister() }) module.handle("onStrafe", function(e) { e.setSpeed(0.5) return e }) module.handle("onMoveInput", function(e) { e.setJump(player.isOnGround()) return e }) [PreviousIntroductionchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api) [NextSimple collide fly bypasschevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/examples/simple-collide-fly-bypass) Last updated 2 years ago --- # Simple collide fly bypass | Rise 6 Scripting API Copy var module = rise.registerModule("Collide Fly", "A fly ported from Rise 5 to Rise 6's scripting api.") module.registerSetting("number", "Speed", 1, 0.1,10,0.1) script.handle("onUnload", function () { module.unregister() }) // Called 20 times per second module.handle("onPreMotion", function(e) { e.setOnGround(true) // Sets players serverground to true player.setMotionY(0) // Sets players motionY to 0 return e }) // We use strafe event because this is called right after keypresses are grabbed, causing the fly to feel more responsive module.handle("onStrafe", function(e) { player.stop() // Stops the player player.strafe(module.getSetting("Speed")) // Sets players speed to setting }) [PreviousSimple vanilla hopchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/examples/simple-vanilla-hop) [NextEvents examplechevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/examples/events-example) Last updated 2 years ago --- # Exempted value speed bypass | Rise 6 Scripting API Copy var module = rise.registerModule("Exempted Value Speed", "A speed ported from Rise 5 to Rise 6's scripting api.") module.registerSetting("mode", "Mode", "1", "1","2","3") script.handle("onUnload", function () { module.unregister() }) // Called 20 times per second, just before the players movement is added for the current tick module.handle("onStrafe", function(e) { // When the player is on the ground, the jump method will be called if (player.onGround) { player.jump() // When the player has been in the air for 1 tick, the players motionY will be set to the given exempted value } else if (player.getAirTicks() == 1) { switch (module.getSetting("Mode")) { case "1": player.setMotionY(-0.0784000015258789) break; case "2": player.setMotionY(-0.09800000190734864) break; case "3": player.setMotionY(-0.09800000190735147) break; } } player.strafe() return e }) [PreviousExample settingschevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/examples/example-settings) [NextPacket nofallchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/examples/packet-nofall) Last updated 2 years ago --- # Events example | Rise 6 Scripting API Copy var module = rise.registerModule("Example", "An example description.") script.handle("onUnload", function () { module.unregister() }) // Called when you attack an entity module.handle("onAttack", function(e) { return e }) // Called when you say something in chat module.handle("onChatInput", function(e) { return e }) // Called when the player clicks module.handle("onClick", function(e) { return e }) // Called when the player attacks another entity and recieves hit slowdown module.handle("onHitSlowDown", function(e) { return e }) // Called when you jump module.handle("onJump", function(e) { return e }) // Called when you press a key module.handle("onKeyboardInput", function(e) { return e }) // Called a player is killed by you module.handle("onKill", function(e) { return e }) // Called when movement inputs are accessed module.handle("onMoveInput", function(e) { return e }) // Called pre motion module.handle("onPostMotion", function(e) { return e }) // Called pre motion module.handle("onPreMotion", function(e) { return e }) // Called pre update module.handle("onPreUpdate", function(e) { return e }) // Called when the 2d ui is drawn module.handle("onRender2D", function(e) { return e }) // Called when the 3d world is drawn module.handle("onRender3D", function(e) { return e }) // Called when the player is slowed down by an item module.handle("onSlowDown", function(e) { return e }) // Called at the start of the clients tick module.handle("onTick", function(e) { return e }) // Called when the client references inWater method module.handle("onWater", function(e) { return e }) // Called 20 times per second, just before the players movement is added for the current tick module.handle("onStrafe", function(e) { print("Test") // Prints "Test" to console return e }) [PreviousSimple collide fly bypasschevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/examples/simple-collide-fly-bypass) [NextExample settingschevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/examples/example-settings) Last updated 2 years ago --- # Example settings | Rise 6 Scripting API Copy var module = rise.registerModule("Example Settings", "An example script to teach how to use rise's scriptapi's settings.") module.registerSetting("number"/*Setting Type*/, "Number Setting"/*Setting Name*/, 1 /*Default Value*/, 0.1/*Min Value*/,10/*Max Value*/,0.1/*Increment*/) module.registerSetting("boundsnumber"/*Setting Type*/, "Bounds Number Setting"/*Setting Name*/, 1 /*Default Value*/, 2/*Default Second Value*/, 0.1/*Min Value*/,10/*Max Value*/,0.1/*Increment*/) module.registerSetting("string"/*Setting Type*/, "String Setting"/*Setting Name*/, "Test" /*Default Value*/) module.registerSetting("mode"/*Setting Type*/, "Mode Setting"/*Setting Name*/, "Mode1"/*Default Mode*/, "Mode1", "Mode2", "Mode3") module.registerSetting("boolean"/*Setting Type*/, "Boolean Setting"/*Setting Name*/, true/*Default Value*/) module.registerSetting("color"/*Setting Type*/, "Color Setting"/*Setting Name*/, 255/*Default Red*/, 255/*Default Green*/, 255/*Default Blue*/) script.handle("onUnload", function () { module.unregister() }) module.handle("onStrafe", function(e) { rise.displayChat(module.getSetting("Number Setting")) rise.displayChat(module.getSetting("Bounds Number Setting")) rise.displayChat(module.getSetting("String Setting")) rise.displayChat(module.getSetting("Mode Setting")) rise.displayChat(module.getSetting("Boolean Setting")) }) [PreviousEvents examplechevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/examples/events-example) [NextExempted value speed bypasschevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/examples/exempted-value-speed-bypass) Last updated 2 years ago --- # BlockPos | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/blockpos#getposition-vector3) `getPosition(): Vector3` Returns the position of the blockpos. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/blockpos#gethardness-number) `getHardness(): Number` Returns the hardness of the block at the blockpos, you can get the amount of ticks it will take to break the block by doing 1 / hardness. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/blockpos#gethardness-int-slot-number) `getHardness(int slot): Number` Returns the hardness using the item in the slot id, read getHardness method description for more information. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/blockpos#getblock-block) `getBlock(): Block` Returns the block at the position. [PreviousItemStackchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/itemstack) [NextBlockchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/block) Last updated 2 years ago --- # Packet nofall | Rise 6 Scripting API Copy var module = rise.registerModule("Packet No Fall", "A No Fall ported from Rise 5 to Rise 6's scripting api.") var fallDistance = 0; script.handle("onUnload", function () { module.unregister() }) // Called 20 times per second module.handle("onPreMotion", function(e) { var difference = player.getLastPosition().getY() - player.getPosition().getY(); if (difference > 0) fallDistance += difference if (player.onGround) fallDistance = 0 if (fallDistance > 2) { packet.sendPosition(true) rise.displayChat("Sent") fallDistance = 0 } return e }) [PreviousExempted value speed bypasschevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/examples/exempted-value-speed-bypass) [NextKillaurachevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/examples/killaura) Last updated 2 years ago --- # Killaura | Rise 6 Scripting API Copy var module = rise.registerModule("ScriptKillaura", "A test KillAura :)") module.registerSetting("number"/*Setting Type*/, "Range"/*Setting Name*/, 3 /*Default Value*/, 3/*Min Value*/,6/*Max Value*/,0.1/*Increment*/) module.registerSetting("boolean"/*Setting Type*/, "RayCast"/*Setting Name*/, true/*Default Value*/) module.registerSetting("boolean"/*Setting Type*/, "Movement Correction"/*Setting Name*/, false/*Default Value*/) script.handle("onUnload", function () { module.unregister() }) module.handle("onPreMotion", function(e) { var entity = world.getTargetEntity(4/*Range*/); if (!entity) return var rotations = player.calculateRotations(entity); rotations.setX(rotations.getX() + (Math.random() - 0.5) * 2) rotations.setY(rotations.getY() + (Math.random() - 0.5) * 2) player.setRotation(rotations, 10, module.getSetting("Movement Correction")) if (Math.random() > 0.1) { player.swingItem() if (!module.getSetting("RayCast") || player.mouseOverEntity(entity, module.getSetting("Range"))) { player.attackEntity(entity) } } return e }) [PreviousPacket nofallchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/examples/packet-nofall) [NextArraylistchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/examples/arraylist) Last updated 2 years ago --- # Arraylist | Rise 6 Scripting API Copy var module = rise.registerModule("Arraylist", "A arraylist made in Rise's script api!") var modules = [] var font = render.getMinecraftFontRenderer() var speed = 0.05; var padding = 2; script.handle("onUnload", function () { module.unregister() }) module.handle("onEnable", function(e) { var unprocessedModules = rise.getModules() modules = [] for (var index = 0; index < unprocessedModules.length; index++) { modules[index] = [unprocessedModules[index], rise.newVec2(0, 0), font.width(unprocessedModules[index].getName())] } modules.sort( function(a, b){ return font.width(b[0].getName()) - font.width(a[0].getName()) } ) }) module.handle("onRender2D", function(e) { var targetPosition = rise.newVec2(10, 10) for (var index = 0; index < modules.length; index++) { var module = modules[index] if (module[0].isEnabled()) { module[1].setX(lerp(module[1].getX(), targetPosition.getX(), speed)) module[1].setY(lerp(module[1].getY(), targetPosition.getY(), speed)) } else { if (module[1].getX() + module[2] < 0) { module[1].setY(targetPosition.getY()) continue } module[1].setX(lerp(module[1].getX(), -module[2] - 1, speed)) } var height = font.height() + padding * 2; if (module[0].isEnabled()) targetPosition.setY(targetPosition.getY() + height) render.rectangle(module[1].getX() - padding, module[1].getY() - 1 - padding, module[2] + (padding * 2), height, [0, 0, 0, 100]) font.drawWithShadow(module[0].getName(), module[1].getX() + padding / 2, module[1].getY() + padding / 2, [255, 255, 255, 255]) } return e }) function lerp(a, b, c) { return a + c * (b - a); } ![](https://riseclients-organization.gitbook.io/rise-6-scripting-api/~gitbook/image?url=https%3A%2F%2F2010882128-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F3Lj04keeX8wqoqjpsLCC%252Fuploads%252FD4BjhROFWX1uSSZvY88p%252Fimage.png%3Falt%3Dmedia%26token%3Dacce9113-45be-4164-abd7-174f46055f49&width=300&dpr=3&quality=100&sign=6d8b0174&sv=2) [PreviousKillaurachevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/examples/killaura) [NextScripting metadatachevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/scripting-metadata) Last updated 2 years ago --- # Objects | Rise 6 Scripting API This page contains documentation about the scripting objects. [PreviousScripting metadatachevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/scripting-metadata) [NextFontRendererchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer) Last updated 3 years ago --- # Global namespaces | Rise 6 Scripting API This page contains documentation about the global namespaces, available in all scripts. [PreviousEntitychevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entity) [Nextrenderchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render) Last updated 3 years ago --- # Vector | Rise 6 Scripting API [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector#instantiating-a-vector) Instantiating a Vector --------------------------------------------------------------------------------------------------------------------------------------------------------------- To instantiate a vector, rise.newVec2(x, y) or rise.newVec3(x, y, z) [PreviousFontRendererchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer) [NextVector3chevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector/vector3) Last updated 3 years ago --- # Scripting metadata | Rise 6 Scripting API Metadata item starts with a //@. Example: circle-info This is optional and not required, as there are default values. Copy //@ author Codera //@ version 1.0 //@ description A script for testing the API. Includes a test module and a test command. //@ noSecurity /* Disabling the security mesaures, */ /* script might not load due to */ /* Unsafe Script support being disabled */ Key Type Description Default value author String The script author, will be displayed in the GUI. Unknown author version String Version of the script. Unknown version description String Description of what the script does. No description provided noSecurity No value passed Allows you to call unsafe functions. **You need to disable Security Measures in the client first, before loading the script, or it will not be loaded.** `false` [PreviousArraylistchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/examples/arraylist) [NextObjectschevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects) Last updated 3 years ago --- # Entity | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entity#isliving-boolean) `isLiving(): Boolean` Returns if the entity is instance of LivingEntity. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entity#getposition-vector3d) `getPosition(): Vector3d` Returns the entity position. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entity#getlastposition-vector3d) `getLastPosition(): Vector3d` Returns the previous tick entity position. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entity#getmotion-vector3d) `getMotion(): Vector3d` Returns the entity motion. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entity#getrotation-vector2f) `getRotation(): Vector2f` Returns the entity rotation. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entity#setyaw-yaw-undefined) `setYaw(yaw): Undefined` Sets the entities yaw. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entity#setpitch-pitch-undefined) `setPitch(pitch): Undefined` Sets the entities pitch. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entity#getlastrotation-vector2f) `getLastRotation(): Vector2f` Returns the previous tick entity rotation. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entity#getticksexisted-number) `getTicksExisted(): Number` Returns the amount of ticks the entity has existed for. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entity#getentityid-number) `getEntityId(): Number` Returns the entity ID. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entity#getdisplayname-string) `getDisplayName(): String` Returns the entity display name. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entity#getinventory-inventory) `getInventory(): Inventory` Returns the inventory of the entity. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entity#getdistancetoentity-entity-number) `getDistanceToEntity(entity): Number` Argument Type Description `entity` `Entity` Another entity. Returns distance between this and another entity. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entity#getdistance-x-y-z-number) `getDistance(x, y, z): Number` Argument Type Description `x` `Number` X position. `y` `Number` Y position. `z` `Number` Z position. Returns the distance between this entity and the specified position. [PreviousEntityLivingchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving) [NextGlobal namespaceschevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces) Last updated 2 years ago --- # FontRenderer | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer#width-text-number) `width(text): Number` Argument Type Description `text` `String` Text to calculate the width of. Returns the text width. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer#height-number) `height(): Number` Returns the font height. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer#draw-text-x-y-color-undefined) `draw(text, x, y, color): Undefined` ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer#drawcentered-text-x-y-color-undefined) `drawCentered(text, x, y, color): Undefined` ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer#drawwithshadow-text-x-y-color-undefined) `drawWithShadow(text, x, y, color): Undefined` ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer#drawcenteredwithshadow-text-x-y-color-undefined) `drawCenteredWithShadow(text, x, y, color): Undefined` Argument Type Description `text` `String` Text to draw. `x` `Number` X position of the string to draw. `y` `Number` Y position of the string to draw. `color` `Number[]` 4-element array with the RGBA color to use. Example: \[255, 255, 255, 255\] would translate to a white color. **You are not required to provide the alpha.** Renders a string. The function name speaks for itself. [PreviousObjectschevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects) [NextVectorchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector) Last updated 3 years ago * [width(text): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer#width-text-number) * [height(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer#height-number) * [draw(text, x, y, color): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer#draw-text-x-y-color-undefined) * [drawCentered(text, x, y, color): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer#drawcentered-text-x-y-color-undefined) * [drawWithShadow(text, x, y, color): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer#drawwithshadow-text-x-y-color-undefined) * [drawCenteredWithShadow(text, x, y, color): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer#drawcenteredwithshadow-text-x-y-color-undefined) --- # Vector3 | Rise 6 Scripting API 3 dimensional vector. Parameters: x, y, z. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector/vector3#getx-number) `getX(): Number` Returns the `X` value. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector/vector3#gety-number) `getY(): Number` Returns the `Y` value. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector/vector3#getz-number) `getZ(): Number` Returns the `Z` value. [PreviousVectorchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector) [NextVector2chevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector/vector2) Last updated 3 years ago * [getX(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector/vector3#getx-number) * [getY(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector/vector3#gety-number) * [getZ(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector/vector3#getz-number) --- # render | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#getcameraposition-vector3) `getCameraPosition(): Vector3` Returns a 3-dimensional vector that stores the camera position. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#rectangle-x-y-width-height-color-undefined) `rectangle(x, y, width, height, color): Undefined` ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#rectangle-x-y-width-height-undefined) `rectangle(x, y, width, height): Undefined` ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#rainbowrectangle-x-y-width-height-undefined) `rainbowRectangle(x, y, width, height): Undefined` ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#centeredrectangle-x-y-width-height-color-undefined) `centeredRectangle(x, y, width, height, color): Undefined` ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#centeredrectangle-x-y-width-height-undefined) `centeredRectangle(x, y, width, height): Undefined` ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#roundedrectangle-x-y-width-height-radius-color) `roundedRectangle(x, y, width, height, radius, color)` ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#roundedrectangleoutline-x-y-width-height-radius-thickness) `roundedRectangleOutline(x, y, width, height, radius, thickness)` Argument Type Description `x` `Number` X position. `y` `Number` Y position. `width` `Number` Rectangle width `height` `Number` Rectangle height `radius` `Number` Rounding radius. `thickness` `Number` Rounded outline rectangle thickness. `color` `Number[]` 3 or 4 dimensional array with the RGBA colors. Renders a rectangle. Names are self-explanatory. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#renderitemicon-x-y-itemstack-undefined) `renderItemIcon(x, y, itemstack): Undefined` Argument Type Description `x` `Number` X position. `y` `Number` Y position. `itemstack` [`ItemStack`](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/itemstack) Item to render. Renders an item icon. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#drawline3d-xfrom-yfrom-zfrom-xto-yto-zto-color-width) `drawLine3D(xFrom, yFrom, zFrom, xTo, yTo, zTo, color, width)` ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#drawline3d-vectorfrom-vectorto-color-width) `drawLine3D(vectorFrom, vectorTo, color, width)` Argument Type Description `xFrom, yFrom, zFrom` or `vectorFrom` `Number` or `Vector3` First position `xTo, yTo, zTo` or `vectorTo` `Number` or `Vector3` Second position `color` `Number[]` 3 or 4 dimensional array with the RGBA colors. `width` `Number` Line width. Draws a line from one position in the world to another. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#smoothcamera-undefined) `smoothCamera(): Undefined` Smoothes the camera out on the Y position by not updating the camera Y position. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#getminecraftfontrenderer-fontrenderer) `getMinecraftFontRenderer():` [`FontRenderer`](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer) ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#getcustomfontrenderer-name-size-antialiasing-fontrenderer) `getCustomFontRenderer(name, size, antialiasing):` [`FontRenderer`](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer) ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#getcustomfontrendererbold-name-size-antialiasing-fontrenderer) `getCustomFontRendererBold(name, size, antialiasing):` [`FontRenderer`](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer) ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#getcustomfontrendereritalic-name-size-antialiasing-fontrenderer) `getCustomFontRendererItalic(name, size, antialiasing):` [`FontRenderer`](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer) ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#getcustomfontrendererbolditalic-name-size-antialiasing-fontrenderer) `getCustomFontRendererBoldItalic(name, size, antialiasing):` [`FontRenderer`](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer) Argument Type Description `name` `String` Font name `size` `Number` Font size `antialiasing` `Boolean` Whether to use anti-aliasing on the font renderer or not. Creates and returns a new [FontRenderer object](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/fontrenderer) . ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#geteyeheight-number) `getEyeHeight(): Number` Returns the eye height. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#getthemecolor-number) `getThemeColor(): Number[]` Returns the theme accent color. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#getbackgroundshade-number) `getBackgroundShade(): Number[]` Returns the background color of Rise Elements, can be used to make your visuals match Rise's. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#getdropshadow-number) `getDropShadow(): Number[]` Returns the bloom drop shadow color of Rise Elements, can be used to make your visuals match Rise's. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#blur-callback-undefined) `blur(callback): Undefined` ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#bloom-callback-undefined) `bloom(callback): Undefined` ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render#outline-callback-undefined) `outline(callback): Undefined` Argument Type Description `callback` `Function` Body of the function to apply a specified effect to. Applies an effect to a block of code. [PreviousGlobal namespaceschevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces) [Nextinputchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input) Last updated 2 years ago --- # ItemStack | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/itemstack#getamount-number) `getAmount(): Number` Returns the amount of items in the itemstack. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/itemstack#getmaxamount-number) `getMaxAmount(): Number` Returns the maximum amount of items that can be stacked in the stack. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/itemstack#getitemid-number) `getItemId(): Number` Returns the Item ID. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/itemstack#getname-string) `getName(): String` Returns the Item **display name**. [PreviousVector2chevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector/vector2) [NextBlockPoschevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/blockpos) Last updated 2 years ago * [getAmount(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/itemstack#getamount-number) * [getMaxAmount(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/itemstack#getmaxamount-number) * [getItemId(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/itemstack#getitemid-number) * [getName(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/itemstack#getname-string) --- # Vector2 | Rise 6 Scripting API 2 dimensional vector. Parameters: x, y. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector/vector2#getx-number) `getX(): Number` Returns the `X` value. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector/vector2#gety-number) `getY(): Number` Returns the `Y` value. [PreviousVector3chevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector/vector3) [NextItemStackchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/itemstack) Last updated 3 years ago * [getX(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector/vector2#getx-number) * [getY(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector/vector2#gety-number) --- # Inventory | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/inventory#gethelditem-itemstack) `getHeldItem(): ItemStack` Returns the current held itemstack. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/inventory#getitemstackinslot-slot-itemstack) `getItemStackInSlot(slot): ItemStack` Returns the item stack in specified slot. [PreviousBlockchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/block) [NextCommandchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/command) Last updated 2 years ago * [getHeldItem(): ItemStack](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/inventory#gethelditem-itemstack) * [getItemStackInSlot(slot): ItemStack](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/inventory#getitemstackinslot-slot-itemstack) --- # Block | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/block#getid-number) `getId(): Number` Returns the block Id. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/block#getname-string) `getName(): String` Returns the block name. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/block#isopaque-boolean) isOpaque`(): Boolean` Returns opaqueness. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/block#isfullblock-boolean) isFullBlock`(): Boolean` Returns true if the block is a full block. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/block#undefined) [PreviousBlockPoschevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/blockpos) [NextInventorychevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/inventory) Last updated 2 years ago * [getId(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/block#getid-number) * [getName(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/block#getname-string) * [isOpaque(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/block#isopaque-boolean) * [isFullBlock(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/block#isfullblock-boolean) * [](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/block#undefined) --- # Command | Rise 6 Scripting API circle-info This page goes over the methods of Command object. For more information, please visit [onExecute event page](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/onexecute-event) . ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/command#unregister-undefined) `unregister(): Undefined` Unregisters the command. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/command#getname-string) `getName(): String` Returns the command name. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/command#getdescription-string) `getDescription(): String` Returns the command description. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/command#handle-type-handler-undefined) `handle(type, handler): Undefined` Argument Type Description `type` `String` The type of event to handle. `handler` `function (args: String[]): Undefined` Callback function. Adds a handler. The only supported callback for commands is `onExecute`. [PreviousInventorychevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/inventory) [NextModulechevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module) Last updated 3 years ago * [unregister(): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/command#unregister-undefined) * [getName(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/command#getname-string) * [getDescription(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/command#getdescription-string) * [handle(type, handler): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/command#handle-type-handler-undefined) --- # Module | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#unregister-undefined) `unregister(): Undefined` Unregisters the module. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#toggle-undefined) `toggle(): Undefined` Toggles the module. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#getname-string) `getName(): String` Returns the module name. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#gettag-string) `getTag(): String` Returns the module tag for arraylists. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#getcategory-string) `getCategory(): String` Returns the module category. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#getdescription-string) `getDescription(): String` Returns the module description. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#isenabled-boolean) `isEnabled(): Boolean` Returns if the module is enabled or not. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#handle-type-handler-undefined) `handle(type, handler): Undefined` Argument Type Description `type` `String` The type of event to handle. `handler` `function (args: String[]): Undefined` Callback function. Adds a event handler. Handler lists can be found in [events documentation](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events) . ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#setenabled-enabled-undefined) `setEnabled(enabled): Undefined` Argument Type Description `enabled` `Boolean` Whether the module will be enabled. Enables/disables the module. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#registersetting-type-name-defaultvalue-params...-undefined) `registerSetting(type, name, defaultValue, params...): Undefined` Argument Type Description `type` `String` The type of setting to register. Currently supported types are: `string`, `number`, `boundsnumber`, `boolean`, `color`, or `mode`. `name` `String` Setting name. `defaultValue` See the description Default value for the setting. Type is: `string` for string settings and mode setting, `Number` for `number`, `boundsnumber` settings, `Boolean` for `boolean` settings, and 3 or 4 element `Number` array for color settings, with the elements corresponding to RGBA. `params...` [Vararg arrow-up-right](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/Rest_parameters) `any` Additional parameters. See below. Registers a setting to the module. For the `number` setting, the first and second additional parameters are minimum and maximum bounds for the setting, while the third one is for the decimal places (**not required, defaults to 2 decimal places.**) Default value type is JS Number. For the `boundsnumber` setting, the first additional parameters argument is the second default value. 2nd and 3rd arguments are minimum and maximum bounds for both of the numbers. The last parameter is step size for the setting. Default value type is JS Number. For the `boolean` and `string` settings, the additional parameters do not exist. Default values for them correspond to their JavaScript types. For the `color` setting, there are no additional parameters. Default value type is a 3 or 4 element array, with the elements corrseponding to the RGB(A) channel values. 4th element for the Alpha channel in the array is not required. For the `mode` setting, the additional parameters are all the sub-modes. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#setsetting-name-value-undefined) `setSetting(name, value): Undefined` Argument Type Description `name` `String` Setting name. `value` See the description The new value for the setting. Type is: `string` for string settings and mode setting, `Number` for `number`, `boundsnumber` settings, `Boolean` for `boolean` settings, and 3 or 4 element `Number` array for color settings, with the elements corresponding to RGBA. Sets a setting of the module. Read the doucmentation for the method above to see more information. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#getsetting-name-boolean-or-or-number-or-or-number-or-or-string) `getSetting(name): Boolean || Number[] || Number || String` Argument Type Description `name` `String` Setting name. Returns the setting value. For the `boolean` setting, it returns a Boolean object. For the `string` setting, it returns a String object. For the `boundsnumber` setting, it returns a 2 element array, with the 1st element corresponding to the 1st value and the 2nd element corresponding to the 2nd value. For the `number` setting, it returns a Number object. For the `color` setting, it returns a 4-element array that you can use in other scripting APIs (Like the [Render API](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render) ). For the `mode` setting, it returns the `mode` name. triangle-exclamation If the setting is not found, this method returns null. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#setsettingvisibility-name-visible-undefined) `setSettingVisibility(name, visible): Undefined` Argument Type Description `name` `String` Setting name. `visible` `Boolean` Whether to draw the setting or not. Sets the setting visibility. circle-exclamation You have to call this method whenever you want to update setting visibility, it does not update automatically. [PreviousCommandchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/command) [NextEntityLivingchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving) Last updated 2 years ago * [unregister(): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#unregister-undefined) * [toggle(): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#toggle-undefined) * [getName(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#getname-string) * [getTag(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#gettag-string) * [getCategory(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#getcategory-string) * [getDescription(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#getdescription-string) * [isEnabled(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#isenabled-boolean) * [handle(type, handler): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#handle-type-handler-undefined) * [setEnabled(enabled): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#setenabled-enabled-undefined) * [registerSetting(type, name, defaultValue, params...): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#registersetting-type-name-defaultvalue-params...-undefined) * [setSetting(name, value): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#setsetting-name-value-undefined) * [getSetting(name): Boolean || Number\[\] || Number || String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#getsetting-name-boolean-or-or-number-or-or-number-or-or-string) * [setSettingVisibility(name, visible): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module#setsettingvisibility-name-visible-undefined) --- # Load event | Rise 6 Scripting API This event will be called upon the **script initialization / initial load / construction of a** `**Script**` **object.** This event **does not** have any parameters**.** Copy script.handle("onLoad", function () { // initialize (register) variables / hooks / modules / commands here } [PreviousEventschevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events) [NextUnload eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/unload-event) Last updated 3 years ago --- # Events | Rise 6 Scripting API This page contains documentation about the scripting events. Each event has the following method: ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events#gethandlername-string) `getHandlerName(): String` This method returns the Event Handler name. circle-info The method above is an internally-used method, should not be used in your scripts. [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events#handling-events) Handling events ----------------------------------------------------------------------------------------------------------------------------------------- To handle an event, call the `handle(handlerName: String, handlerFunction: Function(Event)): Undefined` method on an object that you want your handler to run on. (example: your module, command, the entire script) [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events#cancellable-events) Cancellable events ----------------------------------------------------------------------------------------------------------------------------------------------- Some events can be cancelled, while other events can't be. Cancellable events have 2 methods that non-cancellable events don't. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events#iscancelled-boolean) `isCancelled(): Boolean` Returns if the event has been cancelled or not. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events#setcancelled-cancelled-undefined) `setCancelled(cancelled): Undefined` Sets the cancelled state of the event. [Previouspacketchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet) [NextLoad eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/load-event) --- # Unload event | Rise 6 Scripting API This event will be called upon the **script unload / finalization of a** `**Script**` **object.** This event **does not** have any parameters**.** Copy script.handle("onUnload", function () { // finalize (unregister) variables / hooks / modules / commands here } [PreviousLoad eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/load-event) [NextModule eventschevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events) Last updated 3 years ago --- # network | Rise 6 Scripting API triangle-exclamation **This API is deprecated due to unstable implementation.** Consider using [the Packet API](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet) instead. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/network#sendpacket-id-...parameters-undefined) `sendPacket(id, ...parameters): Undefined` ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/network#receivepacket-id-...parameters-undefined) `receivePacket(id, ...parameters): Undefined` Argument Type Description `id` `Number` Packet ID. 0x03 -> C03, 0x0F -> C0F `...parameters` Variable arguments: `Any` Parameters for instantiation of packet. Mismatch between packet constructor parameters and this variable argument **will cause the script throw an exception.** Those methods will either send a packet to the server, or force the client to receive a packet from the server. circle-info Some packets might be unsupported. If the packet is not supported, **the script will throw an exception**. Every valid packet should be supported. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/network#ismultiplayer-boolean) `isMultiplayer(): Boolean` This method will return if the client is connected to the server. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/network#issingleplayer-boolean) `isSingleplayer(): Boolean` This method will return if the client is playing in singlepalyer. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/network#getserverip-string) `getServerIP(): String` Returns the server IP, if the player is connected to a server. Otherwise, this returns null. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/network#getservername-string) `getServerName(): String` Returns the server name, if the player is connected to a server. Otherwise, this returns null. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/network#getservermotd-string) `getServerMOTD(): String` Returns the server MOTD (Message Of The Day, also known as the text under a server name), if the player is connected to a server. [Previousmcchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/mc) [Nextpacketchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet) Last updated 2 years ago * [sendPacket(id, ...parameters): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/network#sendpacket-id-...parameters-undefined) * [receivePacket(id, ...parameters): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/network#receivepacket-id-...parameters-undefined) * [isMultiplayer(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/network#ismultiplayer-boolean) * [isSingleplayer(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/network#issingleplayer-boolean) * [getServerIP(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/network#getserverip-string) * [getServerName(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/network#getservername-string) * [getServerMOTD(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/network#getservermotd-string) --- # input | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindforwarddown-boolean) `isKeyBindForwardDown(): Boolean` Returns whether the Forward movement key (defaults to W) is down. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindbackdown-boolean) `isKeyBindBackDown(): Boolean` Returns whether the Back movement key (defaults to S) is down. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindleftdown-boolean) `isKeyBindLeftDown(): Boolean` Returns whether the Left movement key (defaults to A) is down. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindrightdown-boolean) `isKeyBindRightDown(): Boolean` Returns whether the Right movement key (defaults to D) is down. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindjumpdown-boolean) `isKeyBindJumpDown(): Boolean` Returns whether the Jump movement key (defaults to Space) is down. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindsneakdown-boolean) `isKeyBindSneakDown(): Boolean` Returns whether the Sneak movement key (defaults to Shift) is down. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindattackdown-boolean) `isKeyBindAttackDown(): Boolean` Returns whether the Attack key (defaults to LMB) is down. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybinduseitemdown-boolean) `isKeyBindUseItemDown(): Boolean` Returns whether the Use Item key (defaults to RMB) is down. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybinddropdown-boolean) `isKeyBindDropDown(): Boolean` Returns whether the Drop key (defaults to Q) is down. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindinventorydown-boolean) `isKeyBindInventoryDown(): Boolean` Returns whether the Inventory key (defaults to E) is down. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindchatdown-boolean) `isKeyBindChatDown(): Boolean` Returns whether the Chat key (defaults to T) is down. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindplayerlistdown-boolean) `isKeyBindPlayerListDown(): Boolean` Returns whether the Player list key (defaults to TAB) is down. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindcommanddown-boolean) `isKeyBindCommandDown(): Boolean` Returns whether the Command key (defaults to '/') is down. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindscreenshotdown-boolean) `isKeyBindScreenshotDown(): Boolean` Returns whether the Screenshot key (defaults to F2) is down. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindtoggleperspectivedown-boolean) `isKeyBindTogglePerspectiveDown(): Boolean` Returns whether the Toggle Perspective (more known as the Third Person) key (defaults to F5) is down. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindfullscreendown-boolean) `isKeyBindFullscreenDown(): Boolean` Returns whether the Full Screen key (defaults to F11) is down. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindspectatoroutlinesdown-boolean) `isKeyBindSpectatorOutlinesDown(): Boolean` Returns whether the Spectatour Outlines key is down. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeydown-key-boolean) `isKeyDown(key): Boolean` Argument Type Description `key` `Number` The LWJGL ID of a key. Returns whether the specified key is down. To get the ID of a key, [refer to this tablearrow-up-right](https://gist.github.com/Mumfrey/5cfc3b7e14fef91b6fa56470dc05218a) . ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#isbuttondown-button-boolean) `isButtonDown(button): Boolean` Argument Type Description `button` `Number` The LWJGL ID of a button. Returns whether the specified mouse button is down. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#ismousedown-button-boolean) `isMouseDown(button): Boolean` Argument Type Description `button` `Number` Mouse button int. Returns whether the specified mouse button is down. [Previousrenderchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/render) [Nextworldchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world) Last updated 1 year ago * [isKeyBindForwardDown(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindforwarddown-boolean) * [isKeyBindBackDown(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindbackdown-boolean) * [isKeyBindLeftDown(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindleftdown-boolean) * [isKeyBindRightDown(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindrightdown-boolean) * [isKeyBindJumpDown(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindjumpdown-boolean) * [isKeyBindSneakDown(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindsneakdown-boolean) * [isKeyBindAttackDown(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindattackdown-boolean) * [isKeyBindUseItemDown(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybinduseitemdown-boolean) * [isKeyBindDropDown(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybinddropdown-boolean) * [isKeyBindInventoryDown(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindinventorydown-boolean) * [isKeyBindChatDown(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindchatdown-boolean) * [isKeyBindPlayerListDown(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindplayerlistdown-boolean) * [isKeyBindCommandDown(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindcommanddown-boolean) * [isKeyBindScreenshotDown(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindscreenshotdown-boolean) * [isKeyBindTogglePerspectiveDown(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindtoggleperspectivedown-boolean) * [isKeyBindFullscreenDown(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindfullscreendown-boolean) * [isKeyBindSpectatorOutlinesDown(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeybindspectatoroutlinesdown-boolean) * [isKeyDown(key): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#iskeydown-key-boolean) * [isButtonDown(button): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#isbuttondown-button-boolean) * [isMouseDown(button): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input#ismousedown-button-boolean) --- # EntityLiving | Rise 6 Scripting API circle-info This object is based on the Entity object. [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#original-methods) Original methods --------------------------------------------------------------------------------------------------------------------------------------------------------- ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#isanimal-boolean) `isAnimal(): Boolean` Returns if the entity is an animal. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#ismob-boolean) `isMob(): Boolean` Returns if the entity is a mob. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#isplayer-boolean) `isPlayer(): Boolean` Returns if the entity is a player. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#gethealth-number) `getHealth(): Number` Returns the entity health. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getmaxhealth-number) `getMaxHealth(): Number` Returns the maximum entity health. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#gethurttime-number) `getHurtTime(): Number` Returns the entity hurt time. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getmaxhurttime-number) `getMaxHurtTime(): Number` Returns the maximum entity hurt time. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getlasthurttime-number) `getLastHurtTime(): Number` Returns the previous tick entity hurt time. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#gethelditemstack-itemstack) `getHeldItemStack(): ItemStack` Returns the currently held item stack of the entity. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#isdead-boolean) `isDead(): Boolean` Returns if the entity is dead. [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#methods-from-superclass) Methods from superclass ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#isliving-boolean) `isLiving(): Boolean` Returns if the entity is instance of LivingEntity. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getposition-vector3d) `getPosition(): Vector3d` Returns the entity position. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getlastposition-vector3d) `getLastPosition(): Vector3d` Returns the previous tick entity position. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getmotion-vector3d) `getMotion(): Vector3d` Returns the entity motion. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getrotation-vector2f) `getRotation(): Vector2f` Returns the entity rotation. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getlastrotation-vector2f) `getLastRotation(): Vector2f` Returns the previous tick entity rotation. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getticksexisted-number) `getTicksExisted(): Number` Returns the amount of ticks the entity has existed for. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getentityid-number) `getEntityId(): Number` Returns the entity ID. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getdisplayname-string) `getDisplayName(): String` Returns the entity display name. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getinventory-inventory) `getInventory(): Inventory` Returns the inventory of the entity. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getdistancetoentity-entity-number) `getDistanceToEntity(entity): Number` Argument Type Description `entity` `Entity` Another entity Returns distance between this and another entity. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getdistance-x-y-z-number) `getDistance(x, y, z): Number` Argument Type Description `x` `Number` X position. `y` `Number` Y position. `z` `Number` Z position. Returns the distance between this entity and the specified position. [PreviousModulechevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/module) [NextEntitychevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entity) Last updated 3 years ago * [Original methods](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#original-methods) * [isAnimal(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#isanimal-boolean) * [isMob(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#ismob-boolean) * [isPlayer(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#isplayer-boolean) * [getHealth(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#gethealth-number) * [getMaxHealth(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getmaxhealth-number) * [getHurtTime(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#gethurttime-number) * [getMaxHurtTime(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getmaxhurttime-number) * [getLastHurtTime(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getlasthurttime-number) * [getHeldItemStack(): ItemStack](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#gethelditemstack-itemstack) * [isDead(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#isdead-boolean) * [Methods from superclass](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#methods-from-superclass) * [isLiving(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#isliving-boolean) * [getPosition(): Vector3d](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getposition-vector3d) * [getLastPosition(): Vector3d](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getlastposition-vector3d) * [getMotion(): Vector3d](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getmotion-vector3d) * [getRotation(): Vector2f](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getrotation-vector2f) * [getLastRotation(): Vector2f](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getlastrotation-vector2f) * [getTicksExisted(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getticksexisted-number) * [getEntityId(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getentityid-number) * [getDisplayName(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getdisplayname-string) * [getInventory(): Inventory](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getinventory-inventory) * [getDistanceToEntity(entity): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getdistancetoentity-entity-number) * [getDistance(x, y, z): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entityliving#getdistance-x-y-z-number) --- # mc | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/mc#getdisplaywidth-number) `getDisplayWidth(): Number` Returns `mc.displayWidth`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/mc#getdisplayheight-number) `getDisplayHeight(): Number` Returns `mc.displayHeight`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/mc#gettimerspeed-number) `getTimerSpeed(): Number` Returns `mc.timer.timerSpeed`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/mc#settimerspeed-timerspeed-undefined) `setTimerSpeed(timerSpeed): Undefined` Argument Type Description `timerSpeed` `Number` The timer speed. Default value is 1. Does not return anything, sets the `timerSpeed` value of `mc.timer` to timerSpeed **parameter**. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/mc#getpartialticks-number) `getPartialTicks(): Number` Returns `mc.timer.elapsedPartialTicks`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/mc#getrenderpartialticks-number) `getRenderPartialTicks(): Number` Returns `mc.timer.renderPartialTicks`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/mc#getfps-number) `getFPS(): Number` Returns fps. [Previousplayerchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player) [Nextnetworkchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/network) Last updated 2 years ago * [getDisplayWidth(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/mc#getdisplaywidth-number) * [getDisplayHeight(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/mc#getdisplayheight-number) * [getTimerSpeed(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/mc#gettimerspeed-number) * [setTimerSpeed(timerSpeed): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/mc#settimerspeed-timerspeed-undefined) * [getPartialTicks(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/mc#getpartialticks-number) * [getRenderPartialTicks(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/mc#getrenderpartialticks-number) * [getFPS(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/mc#getfps-number) --- # world | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world#getdimensionname-string) `getDimensionName(): String` Returns the dimension name. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world#getdimensionid-number) `getDimensionId(): Number` Returns the dimension ID. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world#getdimensiontime-number) `getDimensionTime(): Number` Returns the dimension time. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world#gettargetentity-range-entityliving) `getTargetEntity(range): EntityLiving` Argument Type Description range `Number` The maximum amount of range to get the entity from. Returns the closest targetable entity in a certain range. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world#getentities-entity) `getEntities(): Entity[]` Returns all of the loaded/visible entities. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world#removeentity-entityid-undefined) `removeEntity(entityID): Undefined` Removes entity from the world. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world#removeentity-entity-undefined) `removeEntity(entity): Undefined` Removes entity from the world. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world#newblockpos-x-y-z-blockpos) `newBlockPos(x,y,z): BlockPos` Creates a new block pos. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world#getblockname-blockpos-string) `getBlockName(blockpos): String` Returns the block name. [Previousinputchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/input) [Nextrisechevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise) Last updated 1 year ago * [getDimensionName(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world#getdimensionname-string) * [getDimensionId(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world#getdimensionid-number) * [getDimensionTime(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world#getdimensiontime-number) * [getTargetEntity(range): EntityLiving](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world#gettargetentity-range-entityliving) * [getEntities(): Entity\[\]](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world#getentities-entity) * [removeEntity(entityID): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world#removeentity-entityid-undefined) * [removeEntity(entity): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world#removeentity-entity-undefined) * [newBlockPos(x,y,z): BlockPos](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world#newblockpos-x-y-z-blockpos) * [getBlockName(blockpos): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world#getblockname-blockpos-string) --- # rise | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#registermodule-name-description-module) `registerModule(name, description): Module` Argument Type Description name `String` Name of the module. description `String` Description of the module. Returns and registers a new Module with custom name and description. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#setname-name-undefined) `setName(name): Undefined` Argument Type Description name `String` New name of the client. Renames the client to the new `name`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getmodules-module) `getModules(): Module[]` Returns an array of every module. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getmodule-name-module) `getModule(name): Module` Argument Type Description name `String` The name of the module. Returns a module by name. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#registercommand-name-description-command) `registerCommand(name, description): Command` Argument Type Description name `String` Name of the command description `String` Description of the command. Returns and registers a new Command with custom name and description. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getcommands-command) `getCommands(): Command[]` Returns an array of every command. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getcommand-string-name-command) `getCommand(String name): Command` Argument Type Description name `String` The name of the command. Returns a command by name. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#displaychat-string-message-undefined) `displayChat(String message): Undefined` Argument Type Description message `String` Message to display. Displays a message in chat. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getrisename-string) `getRiseName(): String` Returns the client name. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getriseversion-string) `getRiseVersion(): String` Returns the client version. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getsystemmillis-number) `getSystemMillis(): Number` Returns `System.currentTimeMillis()`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#newvec2-x-y-vector2) `newVec2(x, y): Vector2` Argument Type Description x Number X position y Number Y position Returns a new Vector2 with X and Y as points. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#newvec3-x-y-z-vector3) `newVec3(x, y, z): Vector3` Argument Type Description x Number X position y Number Y position z Number Z position Returns a new Vector3 with X, Y, Z as points. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#displayinfonotification-title-message-time-undefined) `displayInfoNotification(title, message, time?): Undefined` Argument Type Description title String Title of the notification. message String Body/message of the notification. time Number | undefined The amount of time to diplsay the notification for. **This parameter is optional.** Displays a new Information notification. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#pingspoof-delay-normal-teleport-velocity-entity-undefined) `pingspoof(delay, normal?, teleport?, velocity?, entity?): Undefined` Argument Type Description delay Number The ping delay to use/spoof. normal Boolean | undefined The ping spoof type to use. **This parameter is optional.** teleport Boolean | undefined The ping spoof type to use. **This parameter is optional.** velocity Boolean | undefined The ping spoof type to use. **This parameter is optional.** entity Boolean | undefined The ping spoof type to use. **This parameter is optional.** Spoofs the ping. The default mode is `normal`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#blink-undefined) `blink(): Undefined` Blinks the player. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#dispatch-undefined) `dispatch(): Undefined` Sends all delayed/blinked packets. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#pingspoof-number-amount-undefined) `pingspoof(Number amount): Undefined` Delays packets for the amount (in ms). ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getfps-number) `getFPS(): Number` Gets FPS. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getping-number) `getPing(): Number` Gets ping to the current server. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#isbot-number-entityid-boolean) `isBot(Number entityID): Boolean` Returns true if the entity is detected by the antibot. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#isfriend-string-entityname-boolean) `isFriend(String entityName): Boolean` Returns true if the entity is a friend. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getrotations-vector3-positiontorotate-number) `getRotations(Vector3 positionToRotate): Number[]` Returns an array with the first result being the yaw, and the second being the pitch ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getrotations-number-entityid-number) `getRotations(Number entityID): Number[]` Returns an array with the first result being the yaw, and the second being the pitch ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#threadpool-function-function-undefined) `threadPool(Function function): Undefined` Runs a function on the shared Rise ThreadPool, may interfere with other parts of the client if the code you run on it is slow. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#thread-function-function-undefined) `thread(Function function): Undefined` Runs code on a new thread. [Previousworldchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/world) [Nextplayerchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player) Last updated 1 year ago * [registerModule(name, description): Module](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#registermodule-name-description-module) * [setName(name): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#setname-name-undefined) * [getModules(): Module\[\]](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getmodules-module) * [getModule(name): Module](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getmodule-name-module) * [registerCommand(name, description): Command](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#registercommand-name-description-command) * [getCommands(): Command\[\]](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getcommands-command) * [getCommand(String name): Command](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getcommand-string-name-command) * [displayChat(String message): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#displaychat-string-message-undefined) * [getRiseName(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getrisename-string) * [getRiseVersion(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getriseversion-string) * [getSystemMillis(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getsystemmillis-number) * [newVec2(x, y): Vector2](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#newvec2-x-y-vector2) * [newVec3(x, y, z): Vector3](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#newvec3-x-y-z-vector3) * [displayInfoNotification(title, message, time?): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#displayinfonotification-title-message-time-undefined) * [pingspoof(delay, normal?, teleport?, velocity?, entity?): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#pingspoof-delay-normal-teleport-velocity-entity-undefined) * [blink(): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#blink-undefined) * [dispatch(): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#dispatch-undefined) * [pingspoof(Number amount): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#pingspoof-number-amount-undefined) * [getFPS(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getfps-number) * [getPing(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getping-number) * [isBot(Number entityID): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#isbot-number-entityid-boolean) * [isFriend(String entityName): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#isfriend-string-entityname-boolean) * [getRotations(Vector3 positionToRotate): Number\[\]](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getrotations-vector3-positiontorotate-number) * [getRotations(Number entityID): Number\[\]](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#getrotations-number-entityid-number) * [threadPool(Function function): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#threadpool-function-function-undefined) * [thread(Function function): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#thread-function-function-undefined) --- # packet | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendkeepalive-key-undefined) `sendKeepAlive(key): Undefined` Argument Type Description `key` `Number` The keepalive key. Sends a C00 KeepAlive. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendmessage-msg-undefined) `sendMessage(msg): Undefined` Argument Type Description `msg` `String` The message to send. Sends a C01 ChatMessage. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#senduseentity-entity-action-undefined) `sendUseEntity(entity, action): Undefined` Argument Type Description `entity` [`Entity`](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/entity) `| Number` The entity. `action` `string |` [`Vec3`](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector/vector3) The value of C02PacketUseEntity.Action `enum` if string, hitvec otherwise. Sends a C02 UseEntity. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendposition-x-y-z-yaw-pitch-ground-undefined) `sendPosition(x, y, z, yaw, pitch, ground): Undefined` Argument Type Description `x?` `Number` X position. **Must be present alongside Y and Z parameters.** `y?` `Number` Y position. **Must be present alongside X and Z parameters.** `z?` `Number` Z position. **Must be present alongside X and Y parameters.** `yaw?` `Number` Yaw angle rotation. **Must be present alongside X, Y, Z and Pitch parameters.** `pitch?` `Number` Pitch angle rotation. **Must be present alongside X, Y, Z and Yaw parameters.** `ground` `Boolean` Whether the player is on ground. **Required parameter** Sends a C03/C04/C06 Packet. The following method overloads exist: `sendPosition(x, y, z, ground); sendPosition(x, y, z, yaw, pitch, ground); sendPosition(ground)` ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#senddigging-enumstatus-pos-enumfacing-undefined) `sendDigging(enumStatus, pos, enumFacing): Undefined` Argument Type Description `enumStatus` `string` The C07PacketPlayerDigging.Action `enum`. `pos` [`Vec3`](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector/vector3) Block position. `enumFacing` `string` The EnumFacing `enum` value Sends a C07 PlayerDigging. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendplacement-pos-direction-x-y-z-undefined) `sendPlacement(pos, direction, x, y, z): Undefined` Argument Type Description `pos` [`Vec3`](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector/vector3) The placement position. `direction` `Number` The EnumFacing index. `x` `Number` Facing X. `y` `Number` Facing Y. `z` `Number` Facing Z. Sends a C08 PlayerBlockPlacement. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendchangeitem-slot-undefined) `sendChangeItem(slot): Undefined` Argument Type Description `slot` `Number` The new slot to switch to. Sends a C09 HeldItemChange. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendentityaction-entityid-action-undefined) `sendEntityAction(entityId, action): Undefined` Argument Type Description `entityId` `Number` The ID of an entity. `action` `string` The value of C0BPacketEntityAction.Action `enum`. Sends a C0B EntityAction. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendinput-strafespeed-forwardspeed-jumping-sneaking-undefined) `sendInput(strafeSpeed, forwardSpeed, jumping, sneaking): Undefined` Argument Type Description `strafeSpeed` `Number` The player's strafe speed. `forwardSpeed` `Number` The player's forward speed. `jumping` `Boolean` Whether the player is jumping. `sneaking` `Boolean` Whether the player is sneaking. Sends a C0C Input. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendclosewindow-id-undefined) `sendCloseWindow(id): Undefined` Argument Type Description `id` `Number` The window ID. **This parameter is optional**. Sends a C0D CloseWindow. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendenchantitem-window-enchantment-undefined) `sendEnchantItem(window, enchantment): Undefined` Argument Type Description `id` `Number` The window ID. **This parameter is optional**. `enchantment` `Number` The enchantment ID. Sends a C11 EnchantItem. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendtransaction-window-uid-accepted-undefined) `sendTransaction(window, uid, accepted): Undefined` Argument Type Description `window` `Number` The window ID. `uid` `Number` The transaction ID. `accepted` `Boolean` The transaction's `accepted` field. Sends a C0F ConfirmTransaction. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendabilities-flying-allowflying-creativemode-undefined) `sendAbilities(flying, allowFlying, creativeMode): Undefined` Argument Type Description `flying` `Boolean` Whether the player is flying. **This parameter is optional.** `allowFlying` `Boolean` Whether the player can be flying. **This parameter is optional.** `creativeMode` `Boolean` Whether the player is in creative. **This parameter is optional.** Sends a C13 PlayerAbilities. With no parameters supplied, this will send the player's current abilities. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendtabcomplete-msg-pos-undefined) `sendTabComplete(msg, pos): Undefined` Argument Type Description `msg` `string` The message. `pos` [`Vec3`](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/vector/vector3) The position. Sends a C14 TabComplete. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendstatus-status-undefined) `sendStatus(status): Undefined` Argument Type Description `status` `string` The value of C16PacketClientStatus.EnumState Sends a C16 ClientStatus. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendsettings-undefined) `sendSettings(): Undefined` Sends a C15 ClientSettings. [Previousnetworkchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/network) [NextEventschevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events) Last updated 2 years ago * [sendKeepAlive(key): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendkeepalive-key-undefined) * [sendMessage(msg): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendmessage-msg-undefined) * [sendUseEntity(entity, action): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#senduseentity-entity-action-undefined) * [sendPosition(x, y, z, yaw, pitch, ground): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendposition-x-y-z-yaw-pitch-ground-undefined) * [sendDigging(enumStatus, pos, enumFacing): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#senddigging-enumstatus-pos-enumfacing-undefined) * [sendPlacement(pos, direction, x, y, z): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendplacement-pos-direction-x-y-z-undefined) * [sendChangeItem(slot): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendchangeitem-slot-undefined) * [sendEntityAction(entityId, action): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendentityaction-entityid-action-undefined) * [sendInput(strafeSpeed, forwardSpeed, jumping, sneaking): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendinput-strafespeed-forwardspeed-jumping-sneaking-undefined) * [sendCloseWindow(id): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendclosewindow-id-undefined) * [sendEnchantItem(window, enchantment): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendenchantitem-window-enchantment-undefined) * [sendTransaction(window, uid, accepted): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendtransaction-window-uid-accepted-undefined) * [sendAbilities(flying, allowFlying, creativeMode): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendabilities-flying-allowflying-creativemode-undefined) * [sendTabComplete(msg, pos): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendtabcomplete-msg-pos-undefined) * [sendStatus(status): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendstatus-status-undefined) * [sendSettings(): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/packet#sendsettings-undefined) --- # Server Kick event | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/server-kick-event#getreason-string) `**getReason(): String[]**` Returns the kick reason in a list of lines. [PreviousModule Toggle Eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/module-toggle-event) [NextGame eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/game-event) Last updated 2 years ago --- # Attack event | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/attack-event#gettarget-entitylivingbase) `**getTarget(): EntityLivingBase**` Returns the target. [PreviousModule eventschevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events) [NextWorld Change Eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/world-change-event) Last updated 2 years ago --- # onExecute event | Rise 6 Scripting API [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/onexecute-event#onexecute) onExecute --------------------------------------------------------------------------------------------------------------------------------------------- Rise 6 API supports custom commands. To register a command, you have to call [rise.registerCommand(name, description)](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise#registercommand-name-description-command) method. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/onexecute-event#onexecute-arguments) onExecute arguments This event accepts only passes a single argument: An argument array. The type is String\[\]. [PreviousSlow down eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/slow-down-event) Last updated 3 years ago * [onExecute](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/onexecute-event#onexecute) * [onExecute arguments](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/onexecute-event#onexecute-arguments) --- # Module Toggle Event | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/module-toggle-event#getmodule-module) `**getModule(): Module**` Returns the module. [PreviousWorld Change Eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/world-change-event) [NextServer Kick eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/server-kick-event) Last updated 2 years ago --- # player | Rise 6 Scripting API This is based on EntityLiving class, therefore this support every method from Entity, as well as EntityLiving class. [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#methods-from-the-superclasses) Methods from the superclasses --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isanimal-boolean) `isAnimal(): Boolean` Returns if the entity is an animal. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#ismob-boolean) `isMob(): Boolean` Returns if the entity is a mob. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isplayer-boolean) `isPlayer(): Boolean` Returns if the entity is a player. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#gethealth-number) `getHealth(): Number` Returns the entity health. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getmaxhealth-number) `getMaxHealth(): Number` Returns the maximum entity health. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#gethurttime-number) `getHurtTime(): Number` Returns the entity hurt time. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getmaxhurttime-number) `getMaxHurtTime(): Number` Returns the maximum entity hurt time. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getlasthurttime-number) `getLastHurtTime(): Number` Returns the last entity hurt time. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#gethelditemstack-itemstack) `getHeldItemStack(): ItemStack` Returns the held item stack of the entity. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isdead-boolean) `isDead(): Boolean` Returns if the entity is dead. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isliving-boolean) `isLiving(): Boolean` Returns if the entity is instance of LivingEntity. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getposition-vector3) `getPosition(): Vector3` Returns the entity position. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getlastposition-vector3) `getLastPosition(): Vector3` Returns the previous tick entity position. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getmotion-vector3) `getMotion(): Vector3` Returns the entity motion. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getrotation-vector2) `getRotation(): Vector2` Returns the entity rotation. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getlastrotation-vector2) `getLastRotation(): Vector2` Returns the previous tick entity rotation. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getticksexisted-number) `getTicksExisted(): Number` Returns the amount of ticks the entity has existed for. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getentityid-number) `getEntityId(): Number` Returns the entity ID. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getdisplayname-string) `getDisplayName(): String` Returns the entity display name. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getinventory-inventory) `getInventory(): Inventory` Returns the inventory of the entity. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getdistancetoentity-entity-number) `getDistanceToEntity(entity): Number` Argument Type Description entity Entity Another entity Returns distance between this and another entity. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getdistance-x-y-z-number) `getDistance(x, y, z): Number` Argument Type Description `x` `Number` X position. `y` `Number` Y position. `z` `Number` Z position. Returns the distance between this entity and the specified position. [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#exclusive-to-player-api-not-found-in-superclasses) Exclusive to player API, not found in superclasses. --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#message-text-undefined) `message(text): Undefined` Argument Type Description text String Text to send in the chat. Sends a chat message. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getname-string) `getName(): String` Returns the player name. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getplayerid-string) `getPlayerID(): String` Returns the player ID. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isonground-boolean) `**isOnGround(): Boolean**` Returns the `**mc.thePlayer.onGround**` variable ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#ismoving-boolean) `isMoving(): Boolean` Returns if the player is moving or not. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#jump-undefined) `jump(): Undefined` Makes the player jump. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setslot-number-slot-undefined) `setSlot(Number slot): Undefined` Sets your slot. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#strafe-speed-undefined) `strafe(speed): Undefined` Argument Type Description `speed` (**Optional argument**) `Number` The speed to strafe at. Makes the player strafe. `speed` argument is optional. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#stop-undefined) `stop(): Undefined` Stops the player instantly. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setposition-posx-posy-posz-undefined) `setPosition(posX, posY, posZ): Undefined` Argument Type Description posX `Number` Position X. posY `Number` Position Y. posZ `Number` Position Z. Sets the player position with 3 `Number` arguments. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setposition-vector-undefined) `setPosition(vector): Undefined` Argument Type Description `vector` Vector3d Vector3d with the player position. Sets the player motion with a single Vector3d argument. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setmotion-motionx-motiony-motionz-undefined) `setMotion(motionX, motionY, motionZ): Undefined` Argument Type Description motionX `Number` Motion X. motionY `Number` Motion Y. motionZ `Number` Motion Z. Sets the player motion with 3 `Number` arguments. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setmotionx-motionx-undefined) `setMotionX(motionX): Undefined` Argument Type Description motionX `Number` The Motion X to apply to the player. Sets the player motion on the X axis. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setmotiony-motiony-undefined) `setMotionY(motionY): Undefined` Argument Type Description motionY `Number` The Motion Y to apply to the player. Sets the player motion on the Y axis. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setmotionz-motionz-undefined) `setMotionZ(motionZ): Undefined` Argument Type Description motionZ `Number` The Motion Z to apply to the player. Sets the player motion on the Z axis. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setmotion-vector-undefined) `setMotion(vector): Undefined` Argument Type Description `vector` Vector3d Vector3d with the player motion. Sets the player motion with a single Vector3d argument. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#leftclick-undefined) `leftClick(): Undefined` Clicks left mouse button. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#rightclick-undefined) `rightClick(): Undefined` Clicks right mouse button. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#attackentity-target-undefined) `attackEntity(target): Undefined` Argument Type Description `target` `EntityLiving` The entity to attack. Attacks the target entity. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#swingitem-undefined) `swingItem(): Undefined` Swings the currently held item. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#message-message-undefined) `message(message): Undefined` Argument Type Description `message` `String` Message to send Sends a chat message. **You can not execute rise commands with this.** ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setrotation-rotations-rotationspeed-movementfix-undefined) `setRotation(rotations, rotationSpeed, movementFix): Undefined` Argument Type Description `rotations` `Vector2` Angles to rotate to. `rotationSpeed` `Number` Speed to rotate at. 10 is the maximum speed. 1 section is 18 degrees per tick. `movementFix` `Boolean` Whether to fix movement to sync with the rotations or not. Silently rotates your player to a specific set of angles. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#sethelditem-slot-render-undefined) `setHeldItem(slot, render): Undefined` `Run this on preUpdate for every tick you want the slot to be changed, if you want to permanently setslot use the "setSlot" method.` Argument Type Description `slot` `Number` Hotbar slot to use. `render` `Boolean` Whether to render the actually held item. **This argument is optional.** Silently sets a held item. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#gethelditemstack-itemstack-1) `getHeldItemStack():` [`ItemStack`](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/itemstack) Returns the **serverside** held item stack. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getclienthelditemstack-itemstack) `getClientHeldItemStack():` [`ItemStack`](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/objects/itemstack) Returns the **clientside** held item stack. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getclienthelditemslot-number) `getClientHeldItemSlot(): Number` Returns the **clientside** held item slot. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#itemdamage-undefined) `itemDamage(): Undefined` Damages the player using a snowball/fishing rod/bow. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#damage-packet-timer-undefined) `damage(packet, timer): Undefined` Argument Type Description `packet` `Boolean` Whether to do instant damage or slow damage. `timer` `Number` Timer for the slow damage. **This argument is optional and defaults to 1.** Damages the player without an item. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#fakedamage-undefined) `fakeDamage(): Undefined` Fake damages the player. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#calculaterotations-to-vector2) `calculateRotations(to): Vector2` Argument Type Description `to` `Vector3` or `Entity` Entity or position to calculate rotations to. Calculates rotations towards an entity / a position in the world. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#gethurttime-number-1) `getHurtTime(): Number` Returns the players hurt time. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isusingitem-boolean) `isUsingItem(): Boolean` Returns whether the player is using an item. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isholdingsword-boolean) `isHoldingSword(): Boolean` Returns whether the player is holding a sword. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isholdingtool-boolean) `isHoldingTool(): Boolean` Returns whether the player is holding a tool. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isholdingblock-boolean) `isHoldingBlock(): Boolean` Returns whether the player is holding blocks. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getfoward-number) `getFoward(): Number` Returns a value depending on if forward or backwards are being pressed. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getstrafe-number) `getStrafe(): Number` Returns a value depending on if left or right is being pressed. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getspeed-number) `getSpeed(): Number` Returns players speed. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getuseitemprogress-number) getUseItemProgress`(): Number` Returns use item progress. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setsprinting-sprinting-undefined) setSprinting`(sprinting): Undefined` Sets sprinting. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setclientrotations-yaw-pitch-undefined) setClientRotations`(yaw, pitch): Undefined` Sets client rotations. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getuseitemprogress-number-1) getUseItemProgress`(): Number` Returns use item progress. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getfalldistance-number) getFallDistance`(): Number` Returns fall distance. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#gethunger-number) getHunger`(): Number` Returns hunger. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getabsorption-number) getAbsorption`(): Number` Returns absorption. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isinwater-boolean) isInWater`(): Boolean` Returns true if in water. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isinlava-boolean) isInLava`(): Boolean` Returns true if in water. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setsneaking-sneaking-undefined) setSneaking`(sneaking): Undefined` Sets sneaking. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isinweb-boolean) isInWeb`(): Boolean` Returns true if in a web. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isonladder-boolean) isOnLadder`(): Boolean` Returns true if on a ladder. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#iscollided-boolean) isCollided`(): Boolean` Returns true if collided. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#iscollidedhorizontally-boolean) isCollidedHorizontally`(): Boolean` Returns true if collided horizontally. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#iscollidedvertically-boolean) isCollidedVertically`(): Boolean` Returns true if collided vertically. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#ispotionactive-number-potionid-boolean) isPotionActive`(Number potionID): Boolean` Returns true if the potion is active, refer to [https://pastebin.com/U9SyiD9Yarrow-up-right](https://pastebin.com/U9SyiD9Y) for potion ids. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#placeblock-itemstack-heldstack-vector3d-blockpos-number-side-vector3d-hitvec-undefined) placeBlock`(`ItemStack heldStack, Vector3d blockPos, Number side, Vector3d hitVec`): Undefined` Allows you to place a block. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getgui-string) getGUI`(): String` Returns the name of the GUI you're in. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#mouseoverentity-entity-range-boolean) `mouseOverEntity(entity, range): Boolean` Argument Type Description `entity` `Entity` The Entity object of a Entity you want to check. `range` `Number` The maximum distance of the entity (from the player) Returns whether a player is aiming over an entity. **Also includes rotations that are set by other modules.** [Previousrisechevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/rise) [Nextmcchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/mc) Last updated 1 year ago * [Methods from the superclasses](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#methods-from-the-superclasses) * [isAnimal(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isanimal-boolean) * [isMob(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#ismob-boolean) * [isPlayer(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isplayer-boolean) * [getHealth(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#gethealth-number) * [getMaxHealth(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getmaxhealth-number) * [getHurtTime(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#gethurttime-number) * [getMaxHurtTime(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getmaxhurttime-number) * [getLastHurtTime(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getlasthurttime-number) * [getHeldItemStack(): ItemStack](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#gethelditemstack-itemstack) * [isDead(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isdead-boolean) * [isLiving(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isliving-boolean) * [getPosition(): Vector3](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getposition-vector3) * [getLastPosition(): Vector3](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getlastposition-vector3) * [getMotion(): Vector3](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getmotion-vector3) * [getRotation(): Vector2](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getrotation-vector2) * [getLastRotation(): Vector2](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getlastrotation-vector2) * [getTicksExisted(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getticksexisted-number) * [getEntityId(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getentityid-number) * [getDisplayName(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getdisplayname-string) * [getInventory(): Inventory](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getinventory-inventory) * [getDistanceToEntity(entity): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getdistancetoentity-entity-number) * [getDistance(x, y, z): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getdistance-x-y-z-number) * [Exclusive to player API, not found in superclasses.](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#exclusive-to-player-api-not-found-in-superclasses) * [message(text): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#message-text-undefined) * [getName(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getname-string) * [getPlayerID(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getplayerid-string) * [isOnGround(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isonground-boolean) * [isMoving(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#ismoving-boolean) * [jump(): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#jump-undefined) * [setSlot(Number slot): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setslot-number-slot-undefined) * [strafe(speed): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#strafe-speed-undefined) * [stop(): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#stop-undefined) * [setPosition(posX, posY, posZ): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setposition-posx-posy-posz-undefined) * [setPosition(vector): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setposition-vector-undefined) * [setMotion(motionX, motionY, motionZ): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setmotion-motionx-motiony-motionz-undefined) * [setMotionX(motionX): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setmotionx-motionx-undefined) * [setMotionY(motionY): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setmotiony-motiony-undefined) * [setMotionZ(motionZ): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setmotionz-motionz-undefined) * [setMotion(vector): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setmotion-vector-undefined) * [leftClick(): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#leftclick-undefined) * [rightClick(): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#rightclick-undefined) * [attackEntity(target): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#attackentity-target-undefined) * [swingItem(): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#swingitem-undefined) * [message(message): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#message-message-undefined) * [setRotation(rotations, rotationSpeed, movementFix): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setrotation-rotations-rotationspeed-movementfix-undefined) * [setHeldItem(slot, render): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#sethelditem-slot-render-undefined) * [getHeldItemStack(): ItemStack](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#gethelditemstack-itemstack-1) * [getClientHeldItemStack(): ItemStack](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getclienthelditemstack-itemstack) * [getClientHeldItemSlot(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getclienthelditemslot-number) * [itemDamage(): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#itemdamage-undefined) * [damage(packet, timer): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#damage-packet-timer-undefined) * [fakeDamage(): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#fakedamage-undefined) * [calculateRotations(to): Vector2](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#calculaterotations-to-vector2) * [getHurtTime(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#gethurttime-number-1) * [isUsingItem(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isusingitem-boolean) * [isHoldingSword(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isholdingsword-boolean) * [isHoldingTool(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isholdingtool-boolean) * [isHoldingBlock(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isholdingblock-boolean) * [getFoward(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getfoward-number) * [getStrafe(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getstrafe-number) * [getSpeed(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getspeed-number) * [getUseItemProgress(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getuseitemprogress-number) * [setSprinting(sprinting): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setsprinting-sprinting-undefined) * [setClientRotations(yaw, pitch): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setclientrotations-yaw-pitch-undefined) * [getUseItemProgress(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getuseitemprogress-number-1) * [getFallDistance(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getfalldistance-number) * [getHunger(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#gethunger-number) * [getAbsorption(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getabsorption-number) * [isInWater(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isinwater-boolean) * [isInLava(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isinlava-boolean) * [setSneaking(sneaking): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#setsneaking-sneaking-undefined) * [isInWeb(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isinweb-boolean) * [isOnLadder(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#isonladder-boolean) * [isCollided(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#iscollided-boolean) * [isCollidedHorizontally(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#iscollidedhorizontally-boolean) * [isCollidedVertically(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#iscollidedvertically-boolean) * [isPotionActive(Number potionID): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#ispotionactive-number-potionid-boolean) * [placeBlock(ItemStack heldStack, Vector3d blockPos, Number side, Vector3d hitVec): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#placeblock-itemstack-heldstack-vector3d-blockpos-number-side-vector3d-hitvec-undefined) * [getGUI(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#getgui-string) * [mouseOverEntity(entity, range): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/global-namespaces/player#mouseoverentity-entity-range-boolean) Copy Use the corresponding number for the "side" argument in the placeBlock method DOWN(0) UP(1) NORTH(2) SOUTH(3) WEST(4) EAST(5) --- # Game event | Rise 6 Scripting API This event will be called every 5 seconds, even in menus, on another thread. Handler name is `onGame`. [PreviousServer Kick eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/server-kick-event) [NextChat input eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/chat-input-event) Last updated 2 years ago --- # Module events | Rise 6 Scripting API circle-exclamation These event can only be handled by a module object. [PreviousUnload eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/unload-event) [NextAttack eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/attack-event) Last updated 3 years ago --- # World Change Event | Rise 6 Scripting API [PreviousAttack eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/attack-event) [NextModule Toggle Eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/module-toggle-event) Last updated 2 years ago --- # Chat input event | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/chat-input-event#this-event-is-cancellable) **This event is** [**cancellable**](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events#cancellable-events) **.** This event will be called upon the client sending a chat message. Handler name is `onChatInput`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/chat-input-event#getmessage-string) `getMessage(): String` Returns the message. [PreviousGame eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/game-event) [NextClick eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/click-event) Last updated 3 years ago * [This event is cancellable.](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/chat-input-event#this-event-is-cancellable) * [getMessage(): String](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/chat-input-event#getmessage-string) --- # Click event | Rise 6 Scripting API This event will be called upon a **left** click. Handler name is `onClick`. It does not have any methods. [PreviousChat input eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/chat-input-event) [NextEntity render eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/entity-render-event) Last updated 3 years ago --- # Post motion event | Rise 6 Scripting API This event will be called after the motion is applied. Handler name is `onPostMotion`. It does not have any methods. [PreviousMove input eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event) [NextPre motion eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event) Last updated 3 years ago --- # Keyboard Input event | Rise 6 Scripting API This event will be called upon the client user pressing any key. Handler name is `onKeyboardInput`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/keyboard-input-event#getkeycode-number) `getKeyCode(): Number` Returns the keycode. [PreviousJump eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/jump-event) [NextKill eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/kill-event) Last updated 3 years ago --- # Kill event | Rise 6 Scripting API This event will be called upon the player killing another entity. Handler name is `onKill`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/kill-event#getentity-entity) `getEntity(): Entity` Returns the killed entity. [PreviousKeyboard Input eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/keyboard-input-event) [NextMove input eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event) Last updated 3 years ago --- # Entity render event | Rise 6 Scripting API This event will be called upon any entity rendering. This does include non-living entities (such as: FallingBlock, or Painting). Handler name is `onEntityRender`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/entity-render-event#getentity-entity) `getEntity(): Entity` Returns the rendered entity. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/entity-render-event#ispre-boolean) `isPre(): Boolean` Returns if the event is pre or post entity render. [PreviousClick eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/click-event) [NextHit slow down eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/hit-slow-down-event) Last updated 3 years ago * [getEntity(): Entity](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/entity-render-event#getentity-entity) * [isPre(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/entity-render-event#ispre-boolean) --- # Pre update event | Rise 6 Scripting API This event will be called before the entities are updated. Handler name is `onPreUpdate`. It does not have any methods. [PreviousStrafe eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event) [NextRender 2D eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/render-2d-event) Last updated 3 years ago --- # Hit slow down event | Rise 6 Scripting API This event will be called upon you getting slowed down as a result of you attacking another entity. Handler name is `onHitSlowDown`. Default slowdown value is 0.6, default sprint value is false. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/hit-slow-down-event#getslowdown-number) `getSlowDown(): Number` Returns the amount of slowdown. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/hit-slow-down-event#setslowdown-slowdown-undefined) `setSlowDown(slowDown): Undefined` Argument Type Description `slowDown` `Number` Amount of slowdown to apply. Sets the amount of slowdown. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/hit-slow-down-event#setsprint-sprint-undefined) `setSprint(sprint): Undefined` Argument Type Description `sprint` `Boolean` Whether to allow sprinting or not. Allows you to enable/disable sprinting. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/hit-slow-down-event#issprint-boolean) `isSprint(): Boolean` Returns if the sprinting state is set to true or not. [PreviousEntity render eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/entity-render-event) [NextJump eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/jump-event) Last updated 3 years ago * [getSlowDown(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/hit-slow-down-event#getslowdown-number) * [setSlowDown(slowDown): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/hit-slow-down-event#setslowdown-slowdown-undefined) * [setSprint(sprint): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/hit-slow-down-event#setsprint-sprint-undefined) * [isSprint(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/hit-slow-down-event#issprint-boolean) --- # Jump event | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/jump-event#this-event-is-cancellable) **This event is** [**cancellable**](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events#cancellable-events) **.** This event will be called upon you jumping. Handler name is `onJump`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/jump-event#getyaw-number) `getYaw(): Number` Returns the yaw. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/jump-event#setyaw-yaw-undefined) `setYaw(yaw): Undefined` Argument Type Description `yaw` `Number` Yaw to set. Changes your yaw rotation. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/jump-event#setjumpmotion-motion-undefined) `setJumpMotion(motion): Undefined` Argument Type Description `motion` `Number` Jump motion to apply. Changes your jump motion. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/jump-event#getyaw-number-1) `getYaw(): Number` Returns the current jump yaw. [PreviousHit slow down eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/hit-slow-down-event) [NextKeyboard Input eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/keyboard-input-event) Last updated 3 years ago * [This event is cancellable.](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/jump-event#this-event-is-cancellable) * [getYaw(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/jump-event#getyaw-number) * [setYaw(yaw): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/jump-event#setyaw-yaw-undefined) * [setJumpMotion(motion): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/jump-event#setjumpmotion-motion-undefined) * [getYaw(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/jump-event#getyaw-number-1) --- # Tick event | Rise 6 Scripting API This event will be called upon a new tick. Handler name is `onTick`. It does not have any methods. [PreviousWater eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/water-event) [NextSlow down eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/slow-down-event) Last updated 3 years ago --- # Move input event | Rise 6 Scripting API This event will be called upon the player moving manually. Handler name is `onMoveInput`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#setforward-forward-undefined) `setForward(forward): Undefined` Argument Type Description `forward` `Number` Amount of forward movement to apply. Sets the amount of forward movement. By default, if you're not sneaking, the value is either 1 or 0. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#setstrafe-strafe-undefined) `setStrafe(strafe): Undefined` Argument Type Description `strafe` `Number` Amount of strafe movement to apply. Sets the amount of strafe movement. By default, if you're not sneaking, the value is either 1 or 0. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#setjump-jump-undefined) `setJump(jump): Undefined` Argument Type Description `jump` `Boolean` Whether to jump or not. Sets the jump state. By default, if you're not holding the jump key, the value will be false. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#setsneak-sneak-undefined) `setSneak(sneak): Undefined` Argument Type Description `sneak` `Boolean` Whether to sneak or not. Sets the sneaking state. By default, if you're not holding the sneaking key, the value will be false. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#setsneakslowdownmultiplier-multiplier-undefined) `setSneakSlowDownMultiplier(multiplier): Undefined` Argument Type Description `multiplier` `Number` Amount of sneak slowdown multiplier to apply. Sets the amount of sneak slowdown multiplier. By default, if you're not sneaking, the value is 0.3 ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#getforward-number) `getForward(): Number` Returns the forward movement. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#getstrafe-number) `getStrafe(): Number` Returns the strafe movement. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#getsneakslowdownmultiplier-number) `getSneakSlowDownMultiplier(): Number` Returns the sneak slowdown multiplier. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#isjump-boolean) `isJump(): Boolean` Returns whether you will jump or not. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#issneak-boolean) `isSneak(): Boolean` Returns whether you will be sneaking or not. [PreviousKill eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/kill-event) [NextPost motion eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/post-motion-event) Last updated 3 years ago * [setForward(forward): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#setforward-forward-undefined) * [setStrafe(strafe): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#setstrafe-strafe-undefined) * [setJump(jump): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#setjump-jump-undefined) * [setSneak(sneak): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#setsneak-sneak-undefined) * [setSneakSlowDownMultiplier(multiplier): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#setsneakslowdownmultiplier-multiplier-undefined) * [getForward(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#getforward-number) * [getStrafe(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#getstrafe-number) * [getSneakSlowDownMultiplier(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#getsneakslowdownmultiplier-number) * [isJump(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#isjump-boolean) * [isSneak(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/move-input-event#issneak-boolean) --- # Strafe event | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#this-event-is-cancellable) **This event is** [**cancellable**](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events#cancellable-events) **.** This event will be called upon strafing. Handler name is `onStrafe`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#setforward-forward-undefined) `setForward(forward): Undefined` Argument Type Description `forward` `Number` Forward movement to set. Sets the event forward movement. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#setstrafe-strafe-undefined) `setStrafe(strafe): Undefined` Argument Type Description `strafe` `Number` Strafe movement to set. Sets the event strafe movement. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#setfriction-friction-undefined) `setFriction(friction): Undefined` Argument Type Description `friction` `Number` Event friction to set. Sets the event friction. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#setyaw-yaw-undefined) `setYaw(yaw): Undefined` Argument Type Description `yaw` `Number` Event yaw to set Sets the event yaw. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#getforward-number) `getForward(): Number` Returns the forward movement of the event. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#getstrafe-number) `getStrafe(): Number` Returns the strafe movement of the event. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#getfriction-number) `getFriction(): Number` Returns the friction of the event. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#getyaw-number) `getYaw(): Number` Returns the yaw rotation of the event. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#setspeed-speed-motionmultiplier-undefined) `setSpeed(speed, motionMultiplier?): Undefined` Argument Type Description `speed` `Number` Event speed to set. `motionMultiplier` `Number` Motion multiplier for the speed. **This argument is optional.** Applies the speed to the player. [PreviousPre motion eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event) [NextPre update eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-update-event) Last updated 3 years ago * [This event is cancellable.](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#this-event-is-cancellable) * [setForward(forward): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#setforward-forward-undefined) * [setStrafe(strafe): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#setstrafe-strafe-undefined) * [setFriction(friction): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#setfriction-friction-undefined) * [setYaw(yaw): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#setyaw-yaw-undefined) * [getForward(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#getforward-number) * [getStrafe(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#getstrafe-number) * [getFriction(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#getfriction-number) * [getYaw(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#getyaw-number) * [setSpeed(speed, motionMultiplier?): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event#setspeed-speed-motionmultiplier-undefined) --- # Pre motion event | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#this-event-is-cancellable) **This event is** [**cancellable**](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events#cancellable-events) **.** This event will be called before the motion is applied. Handler name is `onPreMotion`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#setposx-posx-undefined) `setPosX(posX): Undefined` Argument Type Description `posX` `Number` Player position X to set. Sets the event position on the X axis. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#setposy-posy-undefined) `setPosY(posY): Undefined` Argument Type Description `posY` `Number` Player position Y to set. Sets the event position on the Y axis. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#setposx-posz-undefined) `setPosX(posZ): Undefined` Argument Type Description `posZ` `Number` Player position Z to set. Sets the event position on the Z axis. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#setyaw-yaw-undefined) `setYaw(yaw): Undefined` Argument Type Description `yaw` `Number` Player yaw rotation to set Sets the event rotation on the yaw axis. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#setpitch-pitch-undefined) `setPitch(pitch): Undefined` Argument Type Description `pitch` `Number` Player pitch rotation to set Sets the event rotation on the pitch axis. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#setonground-groundstate-undefined) `setOnGround(groundState): Undefined` Argument Type Description `groundState` `Boolean` Value of player.onGround to set Sets the event ground state. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#getposx-number) `getPosX(): Number` Returns the Position X of the event. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#getposy-number) `getPosY(): Number` Returns the Position Y of the event. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#getposz-number) `getPosZ(): Number` Returns the Position Z of the event. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#getyaw-number) `getYaw(): Number` Returns the yaw rotation of the event. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#getpitch-number) `getPitch(): Number` Returns the pitch rotation of the event. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#isonground-boolean) `isOnGround(): Boolean` Returns the ground state of the event. [PreviousPost motion eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/post-motion-event) [NextStrafe eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/strafe-event) Last updated 3 years ago * [This event is cancellable.](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#this-event-is-cancellable) * [setPosX(posX): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#setposx-posx-undefined) * [setPosY(posY): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#setposy-posy-undefined) * [setPosX(posZ): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#setposx-posz-undefined) * [setYaw(yaw): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#setyaw-yaw-undefined) * [setPitch(pitch): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#setpitch-pitch-undefined) * [setOnGround(groundState): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#setonground-groundstate-undefined) * [getPosX(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#getposx-number) * [getPosY(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#getposy-number) * [getPosZ(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#getposz-number) * [getYaw(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#getyaw-number) * [getPitch(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#getpitch-number) * [isOnGround(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-motion-event#isonground-boolean) --- # Render 2D event | Rise 6 Scripting API This event will be called upon in-game HUD being rendered. Handler name is `onRender2D`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/render-2d-event#getpartialticks-number) `getPartialTicks(): Number` Returns partial render ticks. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/render-2d-event#getscaledwidth-number) `getScaledWidth(): Number` Returns scaled width. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/render-2d-event#getscaledheight-number) `getScaledHeight(): Number` Returns scaled height. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/render-2d-event#getscalefactor-number) `getScaleFactor(): Number` Returns scale factor. [PreviousPre update eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/pre-update-event) [NextRender 3D eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/render-3d-event) Last updated 3 years ago * [getPartialTicks(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/render-2d-event#getpartialticks-number) * [getScaledWidth(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/render-2d-event#getscaledwidth-number) * [getScaledHeight(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/render-2d-event#getscaledheight-number) * [getScaleFactor(): Number](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/render-2d-event#getscalefactor-number) --- # Slow down event | Rise 6 Scripting API ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/slow-down-event#this-event-is-cancellable) **This event is** [**cancellable**](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events#cancellable-events) **.** This event will be called upon player being slowed down by blocking or using a consumable item. Handler name is `onSlowDown`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/slow-down-event#setforwardmultiplier-multiplier-undefined) `setForwardMultiplier(multiplier): Undefined` Argument Type Description `multiplier` `Number` Amount of forward slowdown to apply. Sets the amount of forward slowdown. Default value is 0.2. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/slow-down-event#setstrafemultiplier-multiplier-undefined) `setStrafeMultiplier(multiplier): Undefined` Argument Type Description `multiplier` `Number` Amount of strafe slowdown to apply. Sets the amount of strafe slowdown. Default value is 0.2. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/slow-down-event#getstrafemultiplier-undefined) `getStrafeMultiplier(): Undefined` Returns the strafe multiplier. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/slow-down-event#getforwardmultiplier-undefined) `getForwardMultiplier(): Undefined` Returns the forward multiplier. [PreviousTick eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/tick-event) [NextonExecute eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/onexecute-event) Last updated 3 years ago * [This event is cancellable.](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/slow-down-event#this-event-is-cancellable) * [setForwardMultiplier(multiplier): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/slow-down-event#setforwardmultiplier-multiplier-undefined) * [setStrafeMultiplier(multiplier): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/slow-down-event#setstrafemultiplier-multiplier-undefined) * [getStrafeMultiplier(): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/slow-down-event#getstrafemultiplier-undefined) * [getForwardMultiplier(): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/slow-down-event#getforwardmultiplier-undefined) --- # Water event | Rise 6 Scripting API This event will be called upon the game checking if you're in water. Handler name is `onWater`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/water-event#setwater-water-undefined) `setWater(water): Undefined` Argument Type Description `water` `Boolean` Whether to apply water logic or not. Sets the event water state. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/water-event#iswater-boolean) `isWater(): Boolean` Returns whether the water state is set to true. [PreviousRender 3D eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/render-3d-event) [NextTick eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/tick-event) Last updated 3 years ago * [setWater(water): Undefined](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/water-event#setwater-water-undefined) * [isWater(): Boolean](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/water-event#iswater-boolean) --- # Render 3D event | Rise 6 Scripting API This event will be called upon the world being rendered. Handler name is `onRender3D`. ### [hashtag](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/render-3d-event#getpartialticks-number) `getPartialTicks(): Number` Returns partial render ticks. [PreviousRender 2D eventchevron-left](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/render-2d-event) [NextWater eventchevron-right](https://riseclients-organization.gitbook.io/rise-6-scripting-api/api-documentation/events/module-events/water-event) Last updated 3 years ago ---