Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface YEvent

Hierarchy

  • YEvent

Index

Methods

Methods

onActivate

  • onActivate(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onActivate(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onActivateInHotbar

  • onActivateInHotbar(triggerEntity: YEntity, targetEntity: YEntity): void
  • onActivateInHotbar(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onActivateInHotbar(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onActivateInHotbar(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onActivateTrap

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onActivateTrap(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onAirtankDepleted

  • onAirtankDepleted(triggerEntity: YEntity, targetEntity: YEntity): void
  • onAirtankDepleted(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onAirtankDepleted(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onAirtankDepleted(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onAnimatorCycleEnd

  • onAnimatorCycleEnd(obj: void): void
  • onAnimatorCycleEnd(animator: YLogic, obj: void): void
  • //@YEvent
    /** @type {(obj: void) => void} */
    function onAnimatorCycleEnd(obj) {
        // your code here
    }
    

    Parameters

    • obj: void

    Returns void

  • //@YEvent
    /** @type {(animator: YLogic, obj: void) => void} */
    function onAnimatorCycleEnd(animator,obj) {
        // your code here
    }
    

    Parameters

    Returns void

onAnswered

  • //@YEvent
    /** @type {(answer: number, questioner: YEntity, player: YCharacter) => void} */
    function onAnswered(answer,questioner,player) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(answer: string, questioner: YEntity, player: YCharacter) => void} */
    function onAnswered(answer,questioner,player) {
        // your code here
    }
    

    Parameters

    Returns void

onAskPlayerAnswered

  • //@YEvent
    /** @type {(askPlayer: YUiAskPlayerWindow, answer: string, questioner: YEntity, player: YCharacter) => void} */
    function onAskPlayerAnswered(askPlayer,answer,questioner,player) {
        // your code here
    }
    

    Parameters

    Returns void

onAttack

  • //@YEvent
    /** @type {(targetEntity: YEntity, attackType: YNpcAttackType) => void} */
    function onAttack(targetEntity,attackType) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(type: YNpcAttackType) => void} */
    function onAttack(type) {
        // your code here
    }
    

    Parameters

    Returns void

onAttackMelee

  • //@YEvent
    /** @type {(triggerEntity: YEntity, weapon: YEntity, attackType: YPlayerAttackType, comboCount: number) => void} */
    function onAttackMelee(triggerEntity,weapon,attackType,comboCount) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, attackType: YPlayerAttackType, comboCount: number) => void} */
    function onAttackMelee(triggerEntity,attackType,comboCount) {
        // your code here
    }
    

    Parameters

    Returns void

onAttackRanged

  • onAttackRanged(triggerEntity: YEntity, weapon: YEntity): void
  • onAttackRanged(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, weapon: YEntity) => void} */
    function onAttackRanged(triggerEntity,weapon) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onAttackRanged(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onAwake

  • onAwake(): void
  • //@YEvent
    /** @type {() => void} */
    function onAwake() {
        // your code here
    }
    

    Returns void

onBehaviourAssigned

  • //@YEvent
    /** @type {(entity: YEntity) => void} */
    function onBehaviourAssigned(entity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(aiBehaviour: YAiBehaviour, entity: YEntity) => void} */
    function onBehaviourAssigned(aiBehaviour,entity) {
        // your code here
    }
    

    Parameters

    Returns void

onBowChargeStart

  • onBowChargeStart(triggerEntity: YEntity, weapon: YEntity): void
  • onBowChargeStart(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, weapon: YEntity) => void} */
    function onBowChargeStart(triggerEntity,weapon) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onBowChargeStart(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onBreak

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onBreak(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onBreak(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onBuildFire

  • onBuildFire(triggerEntity: YEntity, targetEntity: YEntity): void
  • onBuildFire(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onBuildFire(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onBuildFire(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onBurnOut

  • onBurnOut(targetEntity: YEntity): void
  • onBurnOut(): void
  • //@YEvent
    /** @type {(targetEntity: YEntity) => void} */
    function onBurnOut(targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {() => void} */
    function onBurnOut() {
        // your code here
    }
    

    Returns void

onButtonClicked

  • //@YEvent
    /** @type {(player: YCharacter, button: YUiWidget, parameter: string) => void} */
    function onButtonClicked(player,button,parameter) {
        // your code here
    }
    

    Parameters

    Returns void

onChangeSpotlightColor

  • onChangeSpotlightColor(triggerEntity: YEntity, targetEntity: YEntity): void
  • onChangeSpotlightColor(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onChangeSpotlightColor(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onChangeSpotlightColor(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onCharge

  • //@YEvent
    /** @type {(triggerEntity: YEntity, charger: YEntity, amount: number) => void} */
    function onCharge(triggerEntity,charger,amount) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, charger: YEntity, amount: number) => void} */
    function onCharge(triggerEntity,targetEntity,charger,amount) {
        // your code here
    }
    

    Parameters

    Returns void

onClimb

  • onClimb(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onClimb(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onClimbLadder

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onClimbLadder(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onClose

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onClose(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(character: YCharacter) => void} */
    function onClose(character) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onClose(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(player: YCharacter) => void} */
    function onClose(player) {
        // your code here
    }
    

    Parameters

    Returns void

onClosed

  • //@YEvent
    /** @type {(questioner: YEntity, player: YCharacter) => void} */
    function onClosed(questioner,player) {
        // your code here
    }
    

    Parameters

    Returns void

onCollect

  • onCollect(triggerEntity: YEntity, products: any[]): void
  • onCollect(triggerEntity: YEntity, targetEntity: YEntity, products: YEntity[]): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, products: any[]) => void} */
    function onCollect(triggerEntity,products) {
        // your code here
    }
    

    Parameters

    • triggerEntity: YEntity
    • products: any[]

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, products: YEntity[]) => void} */
    function onCollect(triggerEntity,targetEntity,products) {
        // your code here
    }
    

    Parameters

    Returns void

onColorChange

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, oldColor1: YColor, oldColor2: YColor, oldColor3: YColor) => void} */
    function onColorChange(triggerEntity,targetEntity,oldColor1,oldColor2,oldColor3) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, oldColor1: YColor, oldColor2: YColor, oldColor3: YColor) => void} */
    function onColorChange(triggerEntity,oldColor1,oldColor2,oldColor3) {
        // your code here
    }
    

    Parameters

    Returns void

onColorRevert

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, oldColor1: YColor, oldColor2: YColor, oldColor3: YColor) => void} */
    function onColorRevert(triggerEntity,targetEntity,oldColor1,oldColor2,oldColor3) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, oldColor1: YColor, oldColor2: YColor, oldColor3: YColor) => void} */
    function onColorRevert(triggerEntity,oldColor1,oldColor2,oldColor3) {
        // your code here
    }
    

    Parameters

    Returns void

onControl

  • onControl(triggerEntity: YEntity): void
  • onControl(triggerEntity: YEntity): void
  • onControl(triggerEntity: YEntity, targetEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onControl(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onControl(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onControl(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onControlStop

  • onControlStop(triggerEntity: YEntity, targetEntity: YEntity): void
  • onControlStop(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onControlStop(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onControlStop(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onCountChanged

  • onCountChanged(oldCount: number, newCount: number): void
  • //@YEvent
    /** @type {(oldCount: number, newCount: number) => void} */
    function onCountChanged(oldCount,newCount) {
        // your code here
    }
    

    Parameters

    • oldCount: number
    • newCount: number

    Returns void

onCraft

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onCraft(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onCreate

  • onCreate(): void
  • //@YEvent
    /** @type {() => void} */
    function onCreate() {
        // your code here
    }
    

    Returns void

onCreateCampfire

  • //@YEvent
    /** @type {(triggerEntity: YEntity, campfire: YEntity) => void} */
    function onCreateCampfire(triggerEntity,campfire) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, campfire: YEntity) => void} */
    function onCreateCampfire(triggerEntity,targetEntity,campfire) {
        // your code here
    }
    

    Parameters

    Returns void

onCustomAction

  • onCustomAction(player: YCharacter, actionId: string, deltaTime: number): void
  • //@YEvent
    /** @type {(player: YCharacter, actionId: string, deltaTime: number) => void} */
    function onCustomAction(player,actionId,deltaTime) {
        // your code here
    }
    

    Parameters

    • player: YCharacter
    • actionId: string
    • deltaTime: number

    Returns void

onCustomConsoleCommand

  • onCustomConsoleCommand(triggerEntity: YEntity, command: string, args: string[]): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, command: string, args: string[]) => void} */
    function onCustomConsoleCommand(triggerEntity,command,args) {
        // your code here
    }
    

    Parameters

    • triggerEntity: YEntity
    • command: string
    • args: string[]

    Returns void

onCustomInteraction

  • onCustomInteraction(triggerEntity: YEntity, interactionId: string): void
  • onCustomInteraction(triggerEntity: YEntity, targetEntity: YEntity, interactionId: string): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, interactionId: string) => void} */
    function onCustomInteraction(triggerEntity,interactionId) {
        // your code here
    }
    

    Parameters

    • triggerEntity: YEntity
    • interactionId: string

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, interactionId: string) => void} */
    function onCustomInteraction(triggerEntity,targetEntity,interactionId) {
        // your code here
    }
    

    Parameters

    Returns void

onCustomKeyAction

  • onCustomKeyAction(player: YCharacter, keyActionId: string, deltaTime: number): void
  • //@YEvent
    /** @type {(player: YCharacter, keyActionId: string, deltaTime: number) => void} */
    function onCustomKeyAction(player,keyActionId,deltaTime) {
        // your code here
    }
    

    Parameters

    • player: YCharacter
    • keyActionId: string
    • deltaTime: number

    Returns void

onDamage

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, damage: number, type: YDamageType) => void} */
    function onDamage(triggerEntity,targetEntity,damage,type) {
        // your code here
    }
    

    Parameters

    Returns void

onDeactivateInHotbar

  • onDeactivateInHotbar(triggerEntity: YEntity, targetEntity: YEntity): void
  • onDeactivateInHotbar(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onDeactivateInHotbar(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onDeactivateInHotbar(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onDefendEnd

  • onDefendEnd(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onDefendEnd(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onDefendStart

  • onDefendStart(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onDefendStart(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onDefendSuccess

  • //@YEvent
    /** @type {(triggerEntity: YEntity, attacker: YEntity) => void} */
    function onDefendSuccess(triggerEntity,attacker) {
        // your code here
    }
    

    Parameters

    Returns void

onDialogAnswered

  • //@YEvent
    /** @type {(dialogue: YUiDialogWindow, answer: number, questioner: YEntity, player: YCharacter) => void} */
    function onDialogAnswered(dialogue,answer,questioner,player) {
        // your code here
    }
    

    Parameters

    Returns void

onDig

  • //@YEvent
    /** @type {(triggerEntity: YEntity, position: YVector3) => void} */
    function onDig(triggerEntity,position) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, position: YVector3) => void} */
    function onDig(triggerEntity,targetEntity,position) {
        // your code here
    }
    

    Parameters

    Returns void

onDismantle

  • onDismantle(triggerEntity: YEntity): void
  • onDismantle(triggerEntity: YEntity, targetEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onDismantle(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onDismantle(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onDismount

  • onDismount(triggerEntity: YEntity): void
  • onDismount(triggerEntity: YEntity, targetEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onDismount(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onDismount(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onDoDamage

  • //@YEvent
    /** @type {(targetEntity: YEntity, damage: number, type: YDamageType) => void} */
    function onDoDamage(targetEntity,damage,type) {
        // your code here
    }
    

    Parameters

    Returns void

onDodge

  • onDodge(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onDodge(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onDrink

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onDrink(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onDrink(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onDrop

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onDrop(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onDrop(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onEat

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onEat(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onEat(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onEmote

  • //@YEvent
    /** @type {(triggerEntity: YEntity, emote: YEmote) => void} */
    function onEmote(triggerEntity,emote) {
        // your code here
    }
    

    Parameters

    Returns void

onEntityAdded

  • onEntityAdded(entity: YEntity): void
  • //@YEvent
    /** @type {(entity: YEntity) => void} */
    function onEntityAdded(entity) {
        // your code here
    }
    

    Parameters

    Returns void

onEntityAddedToLabel

  • //@YEvent
    /** @type {(entityLabel: YEntityLabel, entity: YEntity) => void} */
    function onEntityAddedToLabel(entityLabel,entity) {
        // your code here
    }
    

    Parameters

    Returns void

onEntityAwake

  • onEntityAwake(targetEntity: YEntity): void
  • //@YEvent
    /** @type {(targetEntity: YEntity) => void} */
    function onEntityAwake(targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onEntityCreate

  • onEntityCreate(targetEntity: YEntity): void
  • //@YEvent
    /** @type {(targetEntity: YEntity) => void} */
    function onEntityCreate(targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onEntityGameStart

  • onEntityGameStart(targetEntity: YEntity): void
  • //@YEvent
    /** @type {(targetEntity: YEntity) => void} */
    function onEntityGameStart(targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onEntityLabelCountChanged

  • onEntityLabelCountChanged(entityLabel: YEntityLabel, oldCount: number, newCount: number): void
  • //@YEvent
    /** @type {(entityLabel: YEntityLabel, oldCount: number, newCount: number) => void} */
    function onEntityLabelCountChanged(entityLabel,oldCount,newCount) {
        // your code here
    }
    

    Parameters

    • entityLabel: YEntityLabel
    • oldCount: number
    • newCount: number

    Returns void

onEntityRemoved

  • onEntityRemoved(entity: YEntity): void
  • //@YEvent
    /** @type {(entity: YEntity) => void} */
    function onEntityRemoved(entity) {
        // your code here
    }
    

    Parameters

    Returns void

onEntityRemovedFromLabel

  • //@YEvent
    /** @type {(entityLabel: YEntityLabel, entity: YEntity) => void} */
    function onEntityRemovedFromLabel(entityLabel,entity) {
        // your code here
    }
    

    Parameters

    Returns void

onEntitySpawn

  • //@YEvent
    /** @type {(entity: YEntity) => void} */
    function onEntitySpawn(entity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(entityTemplate: YEntityTemplate, entity: YEntity) => void} */
    function onEntitySpawn(entityTemplate,entity) {
        // your code here
    }
    

    Parameters

    Returns void

onEquip

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onEquip(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onEquip(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onExplode

  • onExplode(targetEntity: YEntity, hittedEntities: YEntity[]): void
  • onExplode(hittedEntities: YEntity[]): void
  • //@YEvent
    /** @type {(targetEntity: YEntity, hittedEntities: YEntity[]) => void} */
    function onExplode(targetEntity,hittedEntities) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(hittedEntities: YEntity[]) => void} */
    function onExplode(hittedEntities) {
        // your code here
    }
    

    Parameters

    Returns void

onExtinguish

  • onExtinguish(triggerEntity: YEntity): void
  • onExtinguish(triggerEntity: YEntity, targetEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onExtinguish(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onExtinguish(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onFeedAnimal

  • onFeedAnimal(triggerEntity: YEntity, targetEntity: YEntity, foodEntity: void): void
  • onFeedAnimal(triggerEntity: YEntity, foodEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, foodEntity: void) => void} */
    function onFeedAnimal(triggerEntity,targetEntity,foodEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, foodEntity: YEntity) => void} */
    function onFeedAnimal(triggerEntity,foodEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onFeedFire

  • //@YEvent
    /** @type {(triggerEntity: YEntity, fuel: YEntity) => void} */
    function onFeedFire(triggerEntity,fuel) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, fuel: YEntity) => void} */
    function onFeedFire(triggerEntity,targetEntity,fuel) {
        // your code here
    }
    

    Parameters

    Returns void

onFish

  • //@YEvent
    /** @type {(triggerEntity: YEntity, fish: YEntity) => void} */
    function onFish(triggerEntity,fish) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, fish: YEntity) => void} */
    function onFish(triggerEntity,targetEntity,fish) {
        // your code here
    }
    

    Parameters

    Returns void

onFixedUpdate

  • onFixedUpdate(deltaTime: number): void
  • //@YEvent
    /** @type {(deltaTime: number) => void} */
    function onFixedUpdate(deltaTime) {
        // your code here
    }
    

    Parameters

    • deltaTime: number

    Returns void

onFlightEnd

  • onFlightEnd(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onFlightEnd(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onFlightStart

  • onFlightStart(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onFlightStart(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onFreeTrappedEntity

  • //@YEvent
    /** @type {(triggerEntity: YEntity, trappedEntity: YEntity) => void} */
    function onFreeTrappedEntity(triggerEntity,trappedEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, trappedEntity: YEntity) => void} */
    function onFreeTrappedEntity(triggerEntity,targetEntity,trappedEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onFuel

  • //@YEvent
    /** @type {(triggerEntity: YEntity, Fuel: YEntity, amount: number) => void} */
    function onFuel(triggerEntity,Fuel,amount) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, fuel: YEntity, amount: number) => void} */
    function onFuel(triggerEntity,targetEntity,fuel,amount) {
        // your code here
    }
    

    Parameters

    Returns void

onGameLogicSpawn

  • //@YEvent
    /** @type {(gameLogic: YLogic) => void} */
    function onGameLogicSpawn(gameLogic) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(logicTemplate: YLogicTemplate, gameLogic: YLogic) => void} */
    function onGameLogicSpawn(logicTemplate,gameLogic) {
        // your code here
    }
    

    Parameters

    Returns void

onGameStart

  • onGameStart(): void
  • //@YEvent
    /** @type {() => void} */
    function onGameStart() {
        // your code here
    }
    

    Returns void

onGetDamage

  • //@YEvent
    /** @type {(triggerEntity: YEntity, damage: number, type: YDamageType) => void} */
    function onGetDamage(triggerEntity,damage,type) {
        // your code here
    }
    

    Parameters

    Returns void

onGrow

  • onGrow(targetEntity: YEntity): void
  • onGrow(): void
  • //@YEvent
    /** @type {(targetEntity: YEntity) => void} */
    function onGrow(targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {() => void} */
    function onGrow() {
        // your code here
    }
    

    Returns void

onHeavyAttackChargeStart

  • onHeavyAttackChargeStart(triggerEntity: YEntity, weapon: YEntity): void
  • onHeavyAttackChargeStart(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, weapon: YEntity) => void} */
    function onHeavyAttackChargeStart(triggerEntity,weapon) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onHeavyAttackChargeStart(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onIgnite

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onIgnite(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onIgnite(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onInputEditEnded

  • //@YEvent
    /** @type {(player: YCharacter, input: YUiWidget, text: string) => void} */
    function onInputEditEnded(player,input,text) {
        // your code here
    }
    

    Parameters

    Returns void

onInteractWithWorkstation

  • onInteractWithWorkstation(triggerEntity: YEntity): void
  • onInteractWithWorkstation(triggerEntity: YEntity, targetEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onInteractWithWorkstation(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onInteractWithWorkstation(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onItemAddedToInventory

  • onItemAddedToInventory(triggerEntity: YEntity): void
  • onItemAddedToInventory(triggerEntity: YEntity, targetEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onItemAddedToInventory(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onItemAddedToInventory(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onItemPlacingEnded

  • onItemPlacingEnded(triggerEntity: YEntity): void
  • onItemPlacingEnded(triggerEntity: YEntity, targetEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onItemPlacingEnded(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onItemPlacingEnded(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onItemPlacingStarted

  • onItemPlacingStarted(triggerEntity: YEntity): void
  • onItemPlacingStarted(triggerEntity: YEntity, targetEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onItemPlacingStarted(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onItemPlacingStarted(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onItemRemovedFromInventory

  • onItemRemovedFromInventory(triggerEntity: YEntity): void
  • onItemRemovedFromInventory(triggerEntity: YEntity, targetEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onItemRemovedFromInventory(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onItemRemovedFromInventory(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onJump

  • onJump(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onJump(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onKill

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, damage: number, type: YDamageType) => void} */
    function onKill(triggerEntity,targetEntity,damage,type) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, damage: number, type: YDamageType) => void} */
    function onKill(triggerEntity,damage,type) {
        // your code here
    }
    

    Parameters

    Returns void

onLieDown

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onLieDown(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onLieDown(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onLight

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onLight(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onLight(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onLink

  • onLink(triggerEntity: YEntity, targetEntity1: YEntity, targetEntity2: YEntity, port1: number, port2: number): void
  • onLink(triggerEntity: YEntity, targetEntity2: YEntity, port1: number, port2: number): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity1: YEntity, targetEntity2: YEntity, port1: number, port2: number) => void} */
    function onLink(triggerEntity,targetEntity1,targetEntity2,port1,port2) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity2: YEntity, port1: number, port2: number) => void} */
    function onLink(triggerEntity,targetEntity2,port1,port2) {
        // your code here
    }
    

    Parameters

    • triggerEntity: YEntity
    • targetEntity2: YEntity
    • port1: number
    • port2: number

    Returns void

onLock

  • //@YEvent
    /** @type {(triggerEntity: YEntity, key: YEntity) => void} */
    function onLock(triggerEntity,key) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, key: YEntity) => void} */
    function onLock(triggerEntity,targetEntity,key) {
        // your code here
    }
    

    Parameters

    Returns void

onLockPadlock

  • //@YEvent
    /** @type {(triggerEntity: YEntity, padlock: YEntity, key: YEntity) => void} */
    function onLockPadlock(triggerEntity,padlock,key) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, padlock: YEntity, key: YEntity) => void} */
    function onLockPadlock(triggerEntity,targetEntity,padlock,key) {
        // your code here
    }
    

    Parameters

    Returns void

onLogicAdded

  • onLogicAdded(logic: YLogic): void
  • //@YEvent
    /** @type {(logic: YLogic) => void} */
    function onLogicAdded(logic) {
        // your code here
    }
    

    Parameters

    Returns void

onLogicAddedToLabel

  • //@YEvent
    /** @type {(logicLabel: YLogicLabel, logic: YLogic) => void} */
    function onLogicAddedToLabel(logicLabel,logic) {
        // your code here
    }
    

    Parameters

    Returns void

onLogicAwake

  • onLogicAwake(targetLogic: YLogic): void
  • //@YEvent
    /** @type {(targetLogic: YLogic) => void} */
    function onLogicAwake(targetLogic) {
        // your code here
    }
    

    Parameters

    Returns void

onLogicCreate

  • onLogicCreate(targetLogic: YLogic): void
  • //@YEvent
    /** @type {(targetLogic: YLogic) => void} */
    function onLogicCreate(targetLogic) {
        // your code here
    }
    

    Parameters

    Returns void

onLogicGameStart

  • onLogicGameStart(targetLogic: YLogic): void
  • //@YEvent
    /** @type {(targetLogic: YLogic) => void} */
    function onLogicGameStart(targetLogic) {
        // your code here
    }
    

    Parameters

    Returns void

onLogicLabelCountChanged

  • onLogicLabelCountChanged(logicLabel: YLogicLabel, oldCount: number, newCount: number): void
  • //@YEvent
    /** @type {(logicLabel: YLogicLabel, oldCount: number, newCount: number) => void} */
    function onLogicLabelCountChanged(logicLabel,oldCount,newCount) {
        // your code here
    }
    

    Parameters

    • logicLabel: YLogicLabel
    • oldCount: number
    • newCount: number

    Returns void

onLogicRemoved

  • onLogicRemoved(logic: YLogic): void
  • //@YEvent
    /** @type {(logic: YLogic) => void} */
    function onLogicRemoved(logic) {
        // your code here
    }
    

    Parameters

    Returns void

onLogicRemovedFromLabel

  • //@YEvent
    /** @type {(logicLabel: YLogicLabel, logic: YLogic) => void} */
    function onLogicRemovedFromLabel(logicLabel,logic) {
        // your code here
    }
    

    Parameters

    Returns void

onMount

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onMount(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onMount(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onMovementInstructionEnd

  • onMovementInstructionEnd(): void
  • onMovementInstructionEnd(targetLogic: YLogic): void
  • onMovementInstructionEnd(): void
  • onMovementInstructionEnd(targetEntity: YEntity): void
  • //@YEvent
    /** @type {() => void} */
    function onMovementInstructionEnd() {
        // your code here
    }
    

    Returns void

  • //@YEvent
    /** @type {(targetLogic: YLogic) => void} */
    function onMovementInstructionEnd(targetLogic) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {() => void} */
    function onMovementInstructionEnd() {
        // your code here
    }
    

    Returns void

  • //@YEvent
    /** @type {(targetEntity: YEntity) => void} */
    function onMovementInstructionEnd(targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onOpen

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onOpen(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onOpen(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onOpen(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(questioner: YEntity, player: YCharacter) => void} */
    function onOpen(questioner,player) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onOpen(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(player: YCharacter) => void} */
    function onOpen(player) {
        // your code here
    }
    

    Parameters

    Returns void

onOpenFail

  • onOpenFail(triggerEntity: YEntity, targetEntity: YEntity): void
  • onOpenFail(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onOpenFail(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onOpenFail(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onOpenMap

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onOpenMap(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onPack

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onPack(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onPack(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onPetClaimed

  • onPetClaimed(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onPetClaimed(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onPetReleased

  • onPetReleased(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onPetReleased(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onPickEnd

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onPickEnd(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onPickEnd(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onPickStart

  • onPickStart(triggerEntity: YEntity): void
  • onPickStart(triggerEntity: YEntity, targetEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onPickStart(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onPickStart(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onPlace

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onPlace(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onPlace(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onPlant

  • //@YEvent
    /** @type {(triggerEntity: YEntity, plant: YEntity) => void} */
    function onPlant(triggerEntity,plant) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, plant: YEntity) => void} */
    function onPlant(triggerEntity,targetEntity,plant) {
        // your code here
    }
    

    Parameters

    Returns void

onPlayerConnected

  • //@YEvent
    /** @type {(player: YCharacter) => void} */
    function onPlayerConnected(player) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(gameLogic: YLogic, player: YCharacter) => void} */
    function onPlayerConnected(gameLogic,player) {
        // your code here
    }
    

    Parameters

    Returns void

onPlayerCreated

  • //@YEvent
    /** @type {(character: YCharacter) => void} */
    function onPlayerCreated(character) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(spawnPoint: YLogic, character: YCharacter) => void} */
    function onPlayerCreated(spawnPoint,character) {
        // your code here
    }
    

    Parameters

    Returns void

onPlayerDeath

  • //@YEvent
    /** @type {(player: YCharacter) => void} */
    function onPlayerDeath(player) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(gameLogic: YLogic, player: YCharacter) => void} */
    function onPlayerDeath(gameLogic,player) {
        // your code here
    }
    

    Parameters

    Returns void

onPlayerDisconnected

  • //@YEvent
    /** @type {(player: YCharacter) => void} */
    function onPlayerDisconnected(player) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(gameLogic: YLogic, player: YCharacter) => void} */
    function onPlayerDisconnected(gameLogic,player) {
        // your code here
    }
    

    Parameters

    Returns void

onPlayerRespawn

  • //@YEvent
    /** @type {(player: YCharacter) => void} */
    function onPlayerRespawn(player) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(character: YCharacter) => void} */
    function onPlayerRespawn(character) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(gameLogic: YLogic, player: YCharacter) => void} */
    function onPlayerRespawn(gameLogic,player) {
        // your code here
    }
    

    Parameters

    Returns void

onPlayerSpawn

  • //@YEvent
    /** @type {(player: YCharacter) => void} */
    function onPlayerSpawn(player) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(character: YCharacter) => void} */
    function onPlayerSpawn(character) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(gameLogic: YLogic, player: YCharacter) => void} */
    function onPlayerSpawn(gameLogic,player) {
        // your code here
    }
    

    Parameters

    Returns void

onPowerDown

  • onPowerDown(): void
  • onPowerDown(targetEntity: YEntity): void
  • //@YEvent
    /** @type {() => void} */
    function onPowerDown() {
        // your code here
    }
    

    Returns void

  • //@YEvent
    /** @type {(targetEntity: YEntity) => void} */
    function onPowerDown(targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onPowerUp

  • onPowerUp(): void
  • onPowerUp(targetEntity: YEntity): void
  • //@YEvent
    /** @type {() => void} */
    function onPowerUp() {
        // your code here
    }
    

    Returns void

  • //@YEvent
    /** @type {(targetEntity: YEntity) => void} */
    function onPowerUp(targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onRead

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onRead(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onRead(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onRechargeEverythingInRange

  • onRechargeEverythingInRange(triggerEntity: YEntity, chargedEntities: YEntity[]): void
  • onRechargeEverythingInRange(triggerEntity: YEntity, targetEntity: YEntity, chargedEntities: YEntity[]): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, chargedEntities: YEntity[]) => void} */
    function onRechargeEverythingInRange(triggerEntity,chargedEntities) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, chargedEntities: YEntity[]) => void} */
    function onRechargeEverythingInRange(triggerEntity,targetEntity,chargedEntities) {
        // your code here
    }
    

    Parameters

    Returns void

onRefillAirtank

  • onRefillAirtank(triggerEntity: YEntity, targetEntity: YEntity): void
  • onRefillAirtank(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onRefillAirtank(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onRefillAirtank(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onReload

  • onReload(triggerEntity: YEntity, loadedAmmo: number): void
  • onReload(triggerEntity: YEntity, targetEntity: YEntity, loadedAmmo: number): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, loadedAmmo: number) => void} */
    function onReload(triggerEntity,loadedAmmo) {
        // your code here
    }
    

    Parameters

    • triggerEntity: YEntity
    • loadedAmmo: number

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, loadedAmmo: number) => void} */
    function onReload(triggerEntity,targetEntity,loadedAmmo) {
        // your code here
    }
    

    Parameters

    Returns void

onRotationInstructionEnd

  • onRotationInstructionEnd(): void
  • onRotationInstructionEnd(targetLogic: YLogic): void
  • onRotationInstructionEnd(): void
  • onRotationInstructionEnd(targetEntity: YEntity): void
  • //@YEvent
    /** @type {() => void} */
    function onRotationInstructionEnd() {
        // your code here
    }
    

    Returns void

  • //@YEvent
    /** @type {(targetLogic: YLogic) => void} */
    function onRotationInstructionEnd(targetLogic) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {() => void} */
    function onRotationInstructionEnd() {
        // your code here
    }
    

    Returns void

  • //@YEvent
    /** @type {(targetEntity: YEntity) => void} */
    function onRotationInstructionEnd(targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onSaw

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onSaw(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onSaw(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onSit

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onSit(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onSit(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onSkillInterrupted

  • //@YEvent
    /** @type {(player: YCharacter) => void} */
    function onSkillInterrupted(player) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(skill: YSkill, player: YCharacter) => void} */
    function onSkillInterrupted(skill,player) {
        // your code here
    }
    

    Parameters

    Returns void

onSleep

  • onSleep(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onSleep(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onStandUp

  • onStandUp(triggerEntity: YEntity): void
  • onStandUp(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onStandUp(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onStandUp(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onStandUpFromBed

  • onStandUpFromBed(triggerEntity: YEntity, targetEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onStandUpFromBed(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onStandUpFromChair

  • onStandUpFromChair(triggerEntity: YEntity, targetEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onStandUpFromChair(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onSwinEnd

  • onSwinEnd(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onSwinEnd(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onSwinStart

  • onSwinStart(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onSwinStart(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onSwitchOff

  • onSwitchOff(triggerEntity: YEntity): void
  • onSwitchOff(triggerEntity: YEntity, targetEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onSwitchOff(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onSwitchOff(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onSwitchOn

  • onSwitchOn(triggerEntity: YEntity): void
  • onSwitchOn(triggerEntity: YEntity, targetEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onSwitchOn(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onSwitchOn(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onTimeTrigger

  • //@YEvent
    /** @type {(timeTrigger: YTimeTrigger) => void} */
    function onTimeTrigger(timeTrigger) {
        // your code here
    }
    

    Parameters

    Returns void

onTrade

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onTrade(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onTrade(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onTransactionAccepted

  • //@YEvent
    /** @type {(player: YCharacter) => void} */
    function onTransactionAccepted(player) {
        // your code here
    }
    

    Parameters

    Returns void

onTransactionDeclined

  • //@YEvent
    /** @type {(player: YCharacter) => void} */
    function onTransactionDeclined(player) {
        // your code here
    }
    

    Parameters

    Returns void

onTreatWounds

  • onTreatWounds(triggerEntity: YEntity, amount: number): void
  • onTreatWounds(triggerEntity: YEntity, targetEntity: YEntity, amount: number): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, amount: number) => void} */
    function onTreatWounds(triggerEntity,amount) {
        // your code here
    }
    

    Parameters

    • triggerEntity: YEntity
    • amount: number

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, amount: number) => void} */
    function onTreatWounds(triggerEntity,targetEntity,amount) {
        // your code here
    }
    

    Parameters

    Returns void

onTrigger

  • onTrigger(): void
  • onTrigger(triggerEntity: YEntity, targetEntity: YEntity): void
  • //@YEvent
    /** @type {() => void} */
    function onTrigger() {
        // your code here
    }
    

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onTrigger(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onTriggerEnter

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onTriggerEnter(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerLogic: YTriggerZone, triggerEntity: YEntity) => void} */
    function onTriggerEnter(triggerLogic,triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onTriggerExit

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onTriggerExit(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerLogic: YTriggerZone, triggerEntity: YEntity) => void} */
    function onTriggerExit(triggerLogic,triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onUnequip

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onUnequip(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onUnequip(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onUnlink

  • onUnlink(triggerEntity: YEntity, targetEntity1: YEntity, targetEntity2: YEntity, port1: number, port2: number): void
  • onUnlink(triggerEntity: YEntity, targetEntity2: YEntity, port1: number, port2: number): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity1: YEntity, targetEntity2: YEntity, port1: number, port2: number) => void} */
    function onUnlink(triggerEntity,targetEntity1,targetEntity2,port1,port2) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity2: YEntity, port1: number, port2: number) => void} */
    function onUnlink(triggerEntity,targetEntity2,port1,port2) {
        // your code here
    }
    

    Parameters

    • triggerEntity: YEntity
    • targetEntity2: YEntity
    • port1: number
    • port2: number

    Returns void

onUnlock

  • //@YEvent
    /** @type {(triggerEntity: YEntity, key: YEntity) => void} */
    function onUnlock(triggerEntity,key) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, key: YEntity) => void} */
    function onUnlock(triggerEntity,targetEntity,key) {
        // your code here
    }
    

    Parameters

    Returns void

onUnlockPadlock

  • //@YEvent
    /** @type {(triggerEntity: YEntity, padlock: YEntity, key: YEntity) => void} */
    function onUnlockPadlock(triggerEntity,padlock,key) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity, padlock: YEntity, key: YEntity) => void} */
    function onUnlockPadlock(triggerEntity,targetEntity,padlock,key) {
        // your code here
    }
    

    Parameters

    Returns void

onUnpack

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onUnpack(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onUnpack(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onUpdate

  • onUpdate(deltaTime: number): void
  • //@YEvent
    /** @type {(deltaTime: number) => void} */
    function onUpdate(deltaTime) {
        // your code here
    }
    

    Parameters

    • deltaTime: number

    Returns void

onWakeUp

  • onWakeUp(triggerEntity: YEntity): void
  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onWakeUp(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

onWasKilled

  • //@YEvent
    /** @type {(triggerEntity: YEntity, damage: number, type: YDamageType) => void} */
    function onWasKilled(triggerEntity,damage,type) {
        // your code here
    }
    

    Parameters

    Returns void

onWindowClosed

  • //@YEvent
    /** @type {(gameLogic: YLogic, questioner: YEntity, player: YCharacter) => void} */
    function onWindowClosed(gameLogic,questioner,player) {
        // your code here
    }
    

    Parameters

    Returns void

onWindowOpen

  • //@YEvent
    /** @type {(gameLogic: YLogic, questioner: YEntity, player: YCharacter) => void} */
    function onWindowOpen(gameLogic,questioner,player) {
        // your code here
    }
    

    Parameters

    Returns void

onWrite

  • //@YEvent
    /** @type {(triggerEntity: YEntity) => void} */
    function onWrite(triggerEntity) {
        // your code here
    }
    

    Parameters

    Returns void

  • //@YEvent
    /** @type {(triggerEntity: YEntity, targetEntity: YEntity) => void} */
    function onWrite(triggerEntity,targetEntity) {
        // your code here
    }
    

    Parameters

    Returns void

Generated using TypeDoc