@rb-pulse/roblox 1.2.24

package/index.ts

@@ -0,0 +1,503 @@
+/**
+ * @pulse/roblox — Roblox API type declarations for Pulse framework scripts.
+ *
+ * Provides types for Roblox services, instances, enums, and globals so
+ * TypeScript game scripts get full IntelliSense without `any` casts.
+ *
+ * For comprehensive Roblox types, also see: `@rbxts/types`
+ *
+ * @example
+ * ```typescript
+ * import { Players, RunService, Enum } from '@pulse/roblox'
+ *
+ * const player = Players.LocalPlayer
+ * const char   = player.Character
+ * ```
+ */
+
+// ── Instances ──────────────────────────────────────────────────────────────────
+
+export interface Instance {
+  Name:          string
+  Parent:        Instance | undefined
+  ClassName:     string
+  Destroy():     void
+  Clone():       this
+  GetChildren(): Instance[]
+  GetDescendants(): Instance[]
+  IsA(className: string): boolean
+  FindFirstChild(name: string, recursive?: boolean): Instance | undefined
+  FindFirstChildOfClass(className: string): Instance | undefined
+  FindFirstAncestorOfClass(className: string): Instance | undefined
+  WaitForChild(name: string, timeout?: number): Instance
+}
+
+export interface BasePart extends Instance {
+  Position:         Vector3
+  CFrame:           CFrame
+  Size:             Vector3
+  Orientation:      Vector3
+  Anchored:         boolean
+  CanCollide:       boolean
+  CanTouch:         boolean
+  Massless:         boolean
+  Transparency:     number
+  BrickColor:       BrickColor
+  Material:         EnumItem
+  Velocity:         Vector3
+  AssemblyLinearVelocity: Vector3
+}
+
+export interface Part extends BasePart {
+  Shape: EnumItem
+}
+
+export interface MeshPart extends BasePart {
+  MeshId: string
+}
+
+export interface Model extends Instance {
+  PrimaryPart:    BasePart | undefined
+  WorldPivot:     CFrame
+  GetBoundingBox(): [CFrame, Vector3]
+  MoveTo(position: Vector3): void
+  SetPrimaryPartCFrame(cframe: CFrame): void
+  GetChildren(): Instance[]
+}
+
+export interface Humanoid extends Instance {
+  Health:          number
+  MaxHealth:       number
+  WalkSpeed:       number
+  JumpPower:       number
+  JumpHeight:      number
+  AutoRotate:      boolean
+  PlatformStand:   boolean
+  RigType:         EnumItem
+  MoveDirection:   Vector3
+  HipHeight:       number
+  Died:            RBXScriptSignal<[]>
+  HealthChanged:   RBXScriptSignal<[number]>
+  Jumping:         RBXScriptSignal<[boolean]>
+  Running:         RBXScriptSignal<[number]>
+  StateChanged:    RBXScriptSignal<[EnumItem, EnumItem]>
+  GetState():      EnumItem
+  ChangeState(state: EnumItem): void
+  TakeDamage(amount: number): void
+}
+
+export interface HumanoidRootPart extends BasePart {}
+
+export interface AnimationTrack extends Instance {
+  Length:    number
+  Looped:    boolean
+  Speed:     number
+  IsPlaying: boolean
+  Play(fadeTime?: number, weight?: number, speed?: number): void
+  Stop(fadeTime?: number): void
+  AdjustSpeed(speed: number): void
+  AdjustWeight(weight: number, fadeTime?: number): void
+}
+
+export interface Animator extends Instance {
+  LoadAnimation(animation: Instance): AnimationTrack
+  GetPlayingAnimationTracks(): AnimationTrack[]
+}
+
+export interface Camera extends Instance {
+  CFrame:         CFrame
+  Focus:          CFrame
+  CameraType:     EnumItem
+  FieldOfView:    number
+  ViewportSize:   Vector2
+  WorldToViewportPoint(worldPos: Vector3): [Vector3, boolean]
+  WorldToScreenPoint(worldPos: Vector3): [Vector3, boolean]
+  ScreenPointToRay(x: number, y: number, depth?: number): Ray
+}
+
+// ── Player ─────────────────────────────────────────────────────────────────────
+
+export interface Player extends Instance {
+  Name:           string
+  UserId:         number
+  DisplayName:    string
+  Team:           Instance | undefined
+  Character:      Model | undefined
+  CharacterAdded: RBXScriptSignal<[Model]>
+  CharacterRemoving: RBXScriptSignal<[Model]>
+  GetHumanoid(): Humanoid | undefined
+  GetMouse():    Mouse
+  IsInGroup(groupId: number): boolean
+}
+
+export interface Mouse {
+  Hit:      CFrame
+  Origin:   CFrame
+  Target:   BasePart | undefined
+  UnitRay:  Ray
+  X:        number
+  Y:        number
+  ViewSizeX: number
+  ViewSizeY: number
+}
+
+// ── Services ───────────────────────────────────────────────────────────────────
+
+export interface PlayersService {
+  LocalPlayer:          Player
+  GetPlayers():         Player[]
+  GetPlayerFromCharacter(character: Model): Player | undefined
+  PlayerAdded:          RBXScriptSignal<[Player]>
+  PlayerRemoving:       RBXScriptSignal<[Player]>
+}
+
+export interface RunServiceInstance {
+  Heartbeat:     RBXScriptSignal<[number]>
+  RenderStepped: RBXScriptSignal<[number]>
+  Stepped:       RBXScriptSignal<[number, number]>
+  IsClient():    boolean
+  IsServer():    boolean
+  IsStudio():    boolean
+}
+
+export interface UserInputServiceInstance {
+  InputBegan:    RBXScriptSignal<[InputObject, boolean]>
+  InputEnded:    RBXScriptSignal<[InputObject, boolean]>
+  InputChanged:  RBXScriptSignal<[InputObject, boolean]>
+  GetMouseLocation():        Vector2
+  GetMouseDelta():           Vector2
+  IsKeyDown(key: EnumItem):  boolean
+  IsMouseButtonPressed(btn: EnumItem): boolean
+  GetGamepadState(gp: EnumItem): InputObject[]
+  MouseBehavior: EnumItem
+  MouseIconEnabled: boolean
+}
+
+export interface TweenServiceInstance {
+  Create(instance: Instance, info: TweenInfo, goals: Record<string, unknown>): Tween
+}
+
+export interface WorkspaceInstance extends Model {
+  CurrentCamera: Camera
+  Gravity:       number
+  Raycast(origin: Vector3, direction: Vector3, params?: RaycastParams): RaycastResult | undefined
+}
+
+export interface HttpServiceInstance {
+  GetAsync(url: string, nocache?: boolean): string
+  PostAsync(url: string, data: string, contentType?: EnumItem): string
+  JSONEncode(data: unknown): string
+  JSONDecode(data: string): unknown
+}
+
+export interface DataStoreServiceInstance {
+  GetDataStore(name: string, scope?: string): DataStore
+}
+
+export interface DataStore {
+  GetAsync(key: string): unknown
+  SetAsync(key: string, value: unknown): void
+  RemoveAsync(key: string): unknown
+  UpdateAsync(key: string, fn: (oldVal: unknown) => unknown): unknown
+}
+
+export interface TeleportServiceInstance {
+  Teleport(placeId: number, player?: Player): void
+  TeleportToPrivateServer(placeId: number, reservedServerAccessCode: string, players: Player[]): void
+}
+
+// ── DataModel (game) ───────────────────────────────────────────────────────────
+
+export interface DataModel extends Instance {
+  PlaceId:       number
+  GameId:        number
+  Workspace:     WorkspaceInstance
+  Players:       PlayersService
+  RunService:    RunServiceInstance
+  UserInputService: UserInputServiceInstance
+  TweenService:  TweenServiceInstance
+  HttpService:   HttpServiceInstance
+  DataStoreService: DataStoreServiceInstance
+  TeleportService:  TeleportServiceInstance
+  GetService(serviceName: string): Instance
+  HttpGet(url: string, nocache?: boolean): string
+  HttpGetAsync(url: string, nocache?: boolean): string
+}
+
+// ── Math types ────────────────────────────────────────────────────────────────
+
+export interface Vector3 {
+  X: number; Y: number; Z: number
+  Magnitude:    number
+  Unit:         Vector3
+  add(v: Vector3): Vector3
+  sub(v: Vector3): Vector3
+  mul(n: number):  Vector3
+  div(n: number):  Vector3
+  Dot(v: Vector3): number
+  Cross(v: Vector3): Vector3
+  Lerp(v: Vector3, t: number): Vector3
+  new(x: number, y: number, z: number): Vector3
+}
+
+export interface Vector2 {
+  X: number; Y: number
+  Magnitude: number
+  Unit:      Vector2
+  add(v: Vector2): Vector2
+  sub(v: Vector2): Vector2
+  mul(n: number):  Vector2
+  new(x: number, y: number): Vector2
+}
+
+export interface CFrame {
+  Position:      Vector3
+  LookVector:    Vector3
+  RightVector:   Vector3
+  UpVector:      Vector3
+  X: number; Y: number; Z: number
+  mul(cf: CFrame): CFrame
+  ToWorldSpace(cf: CFrame): CFrame
+  ToObjectSpace(cf: CFrame): CFrame
+  PointToWorldSpace(v: Vector3): Vector3
+  PointToObjectSpace(v: Vector3): Vector3
+  Lerp(cf: CFrame, t: number): CFrame
+  new(pos: Vector3, lookAt?: Vector3): CFrame
+}
+
+export interface BrickColor {
+  Name:   string
+  Number: number
+  Color:  Color3
+}
+
+export interface Color3 {
+  R: number; G: number; B: number
+  ToHSV(): [number, number, number]
+  Lerp(c: Color3, t: number): Color3
+  new(r: number, g: number, b: number): Color3
+  fromRGB(r: number, g: number, b: number): Color3
+  fromHSV(h: number, s: number, v: number): Color3
+}
+
+export interface UDim2 {
+  X: UDim; Y: UDim
+  new(xScale: number, xOffset: number, yScale: number, yOffset: number): UDim2
+}
+
+export interface UDim {
+  Scale: number; Offset: number
+}
+
+export interface Ray {
+  Origin:    Vector3
+  Direction: Vector3
+  ClosestPoint(point: Vector3): Vector3
+  Distance(point: Vector3): number
+}
+
+// ── Raycast ───────────────────────────────────────────────────────────────────
+
+export interface RaycastParams {
+  FilterDescendantsInstances: Instance[]
+  FilterType: EnumItem
+  IgnoreWater: boolean
+}
+
+export interface RaycastResult {
+  Instance:  BasePart
+  Position:  Vector3
+  Normal:    Vector3
+  Material:  EnumItem
+  Distance:  number
+}
+
+// ── Tweening ──────────────────────────────────────────────────────────────────
+
+export interface TweenInfo {
+  Time:           number
+  EasingStyle:    EnumItem
+  EasingDirection: EnumItem
+  RepeatCount:    number
+  Reverses:       boolean
+  DelayTime:      number
+  new(time: number, easingStyle?: EnumItem, easingDirection?: EnumItem,
+      repeatCount?: number, reverses?: boolean, delayTime?: number): TweenInfo
+}
+
+export interface Tween extends Instance {
+  PlaybackState: EnumItem
+  Play():  void
+  Pause(): void
+  Cancel(): void
+  Completed: RBXScriptSignal<[EnumItem]>
+}
+
+// ── Input ─────────────────────────────────────────────────────────────────────
+
+export interface InputObject {
+  KeyCode:        EnumItem
+  UserInputType:  EnumItem
+  UserInputState: EnumItem
+  Position:       Vector3
+  Delta:          Vector3
+}
+
+// ── Signals ───────────────────────────────────────────────────────────────────
+
+export interface RBXScriptSignal<T extends unknown[] = []> {
+  Connect(fn: (...args: T) => void): RBXScriptConnection
+  Once(fn: (...args: T) => void): RBXScriptConnection
+  Wait(): LuaMultiReturn<T>
+}
+
+export interface RBXScriptConnection {
+  Connected: boolean
+  Disconnect(): void
+}
+
+export type LuaMultiReturn<T extends unknown[]> = T
+
+// ── Enum ──────────────────────────────────────────────────────────────────────
+
+export interface EnumItem {
+  Name:     string
+  Value:    number
+  EnumType: EnumType
+}
+
+export interface EnumType {
+  GetEnumItems(): EnumItem[]
+}
+
+export declare namespace Enum {
+  namespace KeyCode {
+    const Unknown:         EnumItem
+    const Backspace:       EnumItem
+    const Tab:             EnumItem
+    const Return:          EnumItem
+    const Escape:          EnumItem
+    const Space:           EnumItem
+    const Delete:          EnumItem
+    const A: EnumItem; const B: EnumItem; const C: EnumItem
+    const D: EnumItem; const E: EnumItem; const F: EnumItem
+    const G: EnumItem; const H: EnumItem; const I: EnumItem
+    const J: EnumItem; const K: EnumItem; const L: EnumItem
+    const M: EnumItem; const N: EnumItem; const O: EnumItem
+    const P: EnumItem; const Q: EnumItem; const R: EnumItem
+    const S: EnumItem; const T: EnumItem; const U: EnumItem
+    const V: EnumItem; const W: EnumItem; const X: EnumItem
+    const Y: EnumItem; const Z: EnumItem
+    const Zero: EnumItem; const One:  EnumItem; const Two:   EnumItem
+    const Three: EnumItem; const Four: EnumItem; const Five:  EnumItem
+    const Six: EnumItem; const Seven: EnumItem; const Eight: EnumItem; const Nine: EnumItem
+    const F1:  EnumItem; const F2:  EnumItem; const F3:  EnumItem; const F4:  EnumItem
+    const F5:  EnumItem; const F6:  EnumItem; const F7:  EnumItem; const F8:  EnumItem
+    const F9:  EnumItem; const F10: EnumItem; const F11: EnumItem; const F12: EnumItem
+    const LeftShift:   EnumItem; const RightShift:  EnumItem
+    const LeftControl: EnumItem; const RightControl: EnumItem
+    const LeftAlt:     EnumItem; const RightAlt:    EnumItem
+    const Up: EnumItem; const Down: EnumItem; const Left: EnumItem; const Right: EnumItem
+    const Insert: EnumItem; const Home: EnumItem; const End: EnumItem
+    const PageUp: EnumItem; const PageDown: EnumItem
+    const CapsLock: EnumItem; const NumLock: EnumItem; const ScrollLock: EnumItem
+    const LeftBracket: EnumItem; const RightBracket: EnumItem
+    const Semicolon: EnumItem; const Quote: EnumItem; const Comma: EnumItem
+    const Period: EnumItem; const Slash: EnumItem; const Backslash: EnumItem
+    const Minus: EnumItem; const Equals: EnumItem; const Tilde: EnumItem
+  }
+
+  namespace UserInputType {
+    const None:          EnumItem
+    const MouseButton1:  EnumItem
+    const MouseButton2:  EnumItem
+    const MouseButton3:  EnumItem
+    const MouseWheel:    EnumItem
+    const MouseMovement: EnumItem
+    const Touch:         EnumItem
+    const Keyboard:      EnumItem
+    const Focus:         EnumItem
+    const Accelerometer: EnumItem
+    const Gyro:          EnumItem
+    const Gamepad1:      EnumItem
+    const TextInput:     EnumItem
+  }
+
+  namespace HumanoidStateType {
+    const None:           EnumItem
+    const Jumping:        EnumItem
+    const Flying:         EnumItem
+    const Freefall:       EnumItem
+    const Seated:         EnumItem
+    const Running:        EnumItem
+    const RunningNoPhysics: EnumItem
+    const Climbing:       EnumItem
+    const Swimming:       EnumItem
+    const Dead:           EnumItem
+    const Physics:        EnumItem
+    const Landed:         EnumItem
+    const StrafingNoPhysics: EnumItem
+    const FallingDown:    EnumItem
+    const GettingUp:      EnumItem
+    const PlatformStanding: EnumItem
+  }
+
+  namespace RaycastFilterType {
+    const Include: EnumItem
+    const Exclude: EnumItem
+  }
+
+  namespace EasingStyle {
+    const Linear:    EnumItem; const Quad:     EnumItem; const Cubic:    EnumItem
+    const Quart:     EnumItem; const Quint:    EnumItem; const Sine:     EnumItem
+    const Bounce:    EnumItem; const Elastic:  EnumItem; const Exponential: EnumItem
+    const Circular:  EnumItem; const Back:     EnumItem
+  }
+
+  namespace EasingDirection {
+    const In: EnumItem; const Out: EnumItem; const InOut: EnumItem
+  }
+
+  namespace MouseBehavior {
+    const Default:    EnumItem
+    const LockCenter: EnumItem
+    const LockCurrentPosition: EnumItem
+  }
+
+  namespace Material {
+    const Plastic: EnumItem; const Wood: EnumItem; const Slate: EnumItem
+    const Concrete: EnumItem; const CorrodedMetal: EnumItem; const DiamondPlate: EnumItem
+    const Foil: EnumItem; const Grass: EnumItem; const Ice: EnumItem; const Marble: EnumItem
+    const Granite: EnumItem; const Brick: EnumItem; const Pebble: EnumItem; const Sand: EnumItem
+    const Fabric: EnumItem; const SmoothPlastic: EnumItem; const Metal: EnumItem
+    const WoodPlanks: EnumItem; const Cobblestone: EnumItem; const Air: EnumItem
+    const Water: EnumItem; const Rock: EnumItem; const Glacier: EnumItem; const Snow: EnumItem
+    const Sandstone: EnumItem; const Mud: EnumItem; const Basalt: EnumItem; const Ground: EnumItem
+    const CrackedLava: EnumItem; const Neon: EnumItem; const Glass: EnumItem
+    const Asphalt: EnumItem; const LeafyGrass: EnumItem; const Salt: EnumItem
+    const Limestone: EnumItem; const Pavement: EnumItem
+  }
+}
+
+// ── Globals ───────────────────────────────────────────────────────────────────
+// These are declared as ambient globals in Roblox scripts.
+
+declare const game:      DataModel
+declare const workspace: WorkspaceInstance
+declare const script:    Instance
+
+declare const Players:          PlayersService
+declare const RunService:       RunServiceInstance
+declare const UserInputService: UserInputServiceInstance
+declare const TweenService:     TweenServiceInstance
+declare const HttpService:      HttpServiceInstance
+declare const DataStoreService: DataStoreServiceInstance
+declare const TeleportService:  TeleportServiceInstance
+
+// Export the types so they can be imported explicitly
+export type {
+  DataModel, WorkspaceInstance, PlayersService,
+  RunServiceInstance, UserInputServiceInstance,
+  TweenServiceInstance, HttpServiceInstance,
+}
+export { game, workspace, script, Players, RunService, UserInputService, TweenService }

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@rb-pulse/roblox",
+  "version": "1.2.24",
+  "description": "Pulse framework — Roblox API type declarations for TypeScript game scripts",
+  "main": "./index.ts",
+  "types": "./index.ts",
+  "files": [
+    "index.ts",
+    "*.d.ts"
+  ],
+  "keywords": [
+    "roblox",
+    "pulse",
+    "lua",
+    "typescript",
+    "types"
+  ],
+  "license": "MIT"
+}