figura-ts/types/event.d.ts

Lua Types for the Minecraft Mod Figura

declare type FiguraEventMap = {
    // no return
    "ENTITY_INIT": (this: void) => void
    "WORLD_TICK": (this: void) => void
    "WORLD_RENDER": (this: void,delta: number) => void
    "TICK": (this: void) => void
    "RENDER": (this: void,delta: number,renderMode: RenderMode,poseMatrix: FiguraMat4) => void
    "POST_RENDER": (this: void,delta: number,renderMode: RenderMode,poseMatrix: FiguraMat4) => void
    "POST_WORLD_RENDER": (this: void,delta: number) => void
    "RESOURCE_RELOAD": (this: void) => void
    "DAMAGE": (this: void,sourceType: string,sourceCause: FiguraEntity,sourceDirect: FiguraEntity,sourcePosition: FiguraVec3) => void
    "CHAR_TYPED": (this: void,chars: string,modifiers: number,codePoint: number) => void
    // cancable
    "SKULL_RENDER": (this: void,delta: number,block: FiguraBlockState,item: FiguraItemStack,entity: FiguraEntity,mode: SkullMode) => void | boolean
    "USE_ITEM": (this: void,stack: FiguraItemStack,type: UseAction,particleCount: number) => void | boolean
    "ARROW_RENDER": (this: void,delta: number,arrow: FiguraEntity) => void | boolean
    "TRIDENT_RENDER": (this: void,delta: number,trident: FiguraEntity) => void | boolean
    "ON_PLAY_SOUND": (this: void,id: string,pos: FiguraVec3,vol: number,pitch: number,loop: boolean,category: SoundCategory,file: string) => void | boolean
    "MOUSE_SCROLL": (this: void,delta: number) => void | boolean
    "MOUSE_MOVE": (this: void,x: number,y: number) => void | boolean
    "MOUSE_PRESS": (this: void,button: number,action: number,modifiers: number) => void | boolean
    "KEY_PRESS": (this: void,key: number,action: number,modifiers: number) => void | boolean
    "TOTEM": (this: void) => void | boolean
    // special
    "ITEM_RENDER": (this: void,item: FiguraItemStack,mode: ItemDisplayMode,pos: FiguraVec3,rot: FiguraVec3,scale: FiguraVec3,leftHanded: boolean) => void | FiguraModelPart
    "CHAT_SEND_MESSAGE": (this: void,message: string) => void | string
    "CHAT_RECEIVE_MESSAGE": (this: void,message: string,json: string) => void | boolean | LuaMultiReturn<[string,FiguraVec3]> | LuaMultiReturn<[string]>
}
declare type FiguraEventEntries = {
    [x in keyof FiguraEventMap]: FiguraLuaEvent<FiguraEventMap[x]>
}
type EventCallbacks = {
    [x in keyof FiguraEventMap as Lowercase<x>]: FiguraEventMap[x]
}
interface EventMethods
{
    getEvents(): LuaMap<keyof FiguraEventMap,FiguraLuaEvent>
}
declare type FiguraEvents = EventMethods & FiguraEventEntries & EventCallbacks
declare const events: FiguraEvents
declare interface FiguraLuaEvent<Func extends (...args: Array<any>) => void = () => void>
{
    register(func: Func): this
    register(func: Func,name: string): this
    clear(): void
    remove(name: string): number
    remove(func: Func): number
    getRegisteredCount(name: string): number
}