API Documentation

Weave Scripting API

K
Introduction

Help & Support

Join our Discord

Introduction

Welcome to the Weave Scripting API documentation. This reference covers all available functions for creating custom scripts. Functions are organized by category for easy navigation.

Use the search bar in the sidebar to quickly find specific functions, or browse the categories below.

Self.Id

Returns your local Ped Handle (PlayerPedId).

Self.ServerId

Returns your current Server ID (GetPlayerServerId).

Self.Pos

Returns your current Vector3 coordinates.

Self.Heal

Sets health to the specified percentage (0-100). Also clears blood and visible damage.

Self.Armor

Sets your armor level (0-100).

Self.Teleport

Instantly moves you to the specified coordinates.

Self.ToWaypoint

Teleports you to your map marker with an automatic ground-height check.

Self.Clean

Removes all blood, wetness, and visible injuries from your character.

IsPlayerInvisible

Checks if a specific player or NPC is trying to hide using invisibility or 0% alpha transparency.

RagdollPlayer

Instantly forces the target player into a falling (ragdoll) state.

SpoofPed

Changes your ped model using a stealth bypass that avoids typical model-change logs.

Need help?

Join our Discord for live support and community help.

Join Discord