Melonity Docs

ScriptDescription ​

The ScriptDescription interface defines the public callback hooks that can be registered by a script.

Properties ​

OnLocalPlayerCreate() => void ​

The on local player create.

OnLocalPlayerDestroy() => void ​

The on local player destroy.

OnLocalHeroCreate() => void ​

The on local hero create.

OnLocalHeroDestroy() => void ​

The on local hero destroy.

OnGameStart() => void ​

The on game start.

IMPORTANT

Same as OnLocalHeroCreate

OnGameEnd() => void ​

The on game end.

IMPORTANT

Same as OnLocalHeroDestroy

OnScriptLoad() => void ​

The on script load.

OnScriptUnload() => void ​

The on script unload.

OnDraw() => void ​

The on draw.

OnDrawOverUI() => void ​

The on draw over ui.

OnUpdate() => void ​

The on update.

OnKeyEvent(event: KeyEventObject) => void ​

The on key event.

OnEntityCreate(entity: Entity, index: number) => void ​

The on entity create.

OnEntityCreateUpdated(entity: Entity, index: number) => void ​

The on entity create updated.

OnEntityDestroy(entity: Entity, index: number) => void ​

The on entity destroy.

OnModifierCreate(entity: NPC, modifier: Modifier) => void ​

The on modifier create.

OnModifierDestroy(entity: NPC, modifier: Modifier) => void ​

The on modifier destroy.

OnScreenSizeChange(width: number, height: number) => void ​

The on screen size change.

OnFireEvent(event: FireEventObject) => void ​

The on fire event.

OnCreateClickEffect(obj: CreateClickEffectObject) => boolean | Vector | void ​

The on create click effect.

OnPrepareUnitOrders(order: PreparedOrder) => boolean | void ​

The on prepare unit orders.

OnScriptPrepareUnitOrders(order: PreparedOrder, caller: string) => boolean | void ​

The on script prepare unit orders.

OnUnitAnimation(animation: UnitAnimationCallbackObject) => void ​

The on unit animation.

OnUnitAnimationEnd(animation: UnitAnimationEndCallbackObject) => void ​

The on unit animation end.

OnSendNetMessage(obj: ProtobufLiteObject) => Enum.ProtobufBehavior | object | void ​

The on send net message.

WARNING

Deprecated. use NetMessages.RegisterSend instead

OnRecvNetMessage(obj: ProtobufLiteObject) => Enum.ProtobufBehavior | object | void ​

The on recv net message.

WARNING

Deprecated. use NetMessages.RegisterRecv instead

OnFrameStageNotify(stage: number) => void ​

The on frame stage notify.

WARNING

Deprecated. disabled

OnSendGCMessage(obj: ProtobufLiteObject, type: number) => Enum.ProtobufBehavior | object | void ​

Return Enum.ProtobufBehavior.Ignore to ignore the message or object to modify the message

OnRecvGCMessage(obj: ProtobufLiteObject, type: number) => Enum.ProtobufBehavior | object | void ​

Return Enum.ProtobufBehavior.Ignore to ignore the message or object to modify the message

OnDrawCreepCampIcon(position: Vector) => boolean | void ​

The on draw creep camp icon.

WARNING

Deprecated. disabled

OnChatEvent(event: OnChatEventObject) => void ​

The on chat event.

OnVisibilityUpdate(ent: NPC, reason: string, visible: boolean) => void ​

The on visibility update.

OnTeamVisablityChange(npc: NPC, oldValue: number, newValue: number) => void ​

The on team visablity change.

OnSayMsg(obj: OnSayMsgObject) => boolean | void ​

The on say msg.

OnChatWrite(obj: OnChatWriteObject) => boolean | void ​

The on chat write.

OnChatMessage(obj: OnChatMessageObject) => void ​

The on chat message.

OnGCSOCreated(obj: ProtobufLiteObject) => void ​

The on gcsocreated.

OnGCSOUpdated(obj: ProtobufLiteObject) => void ​

The on gcsoupdated.

OnGCSOChanged(obj: ProtobufLiteObject, reason: number) => void ​

The on gcsochanged.

OnOverheadEvent(obj: OnOverheadEventFallback) => void ​

The on overhead event.

OnUnitAddGesture(anim: UnitAddGestureObject) => void ​

The on unit add gesture.

OnProjectile(projectile: Projectile) => void ​

The on projectile.

OnProjectileLoc(projectile: OnProjectileLocObject) => void ​

The on projectile loc.

OnLinearProjectileCreate(projectile: LinearProjectile) => void ​

The on linear projectile create.

OnLinearProjectileDestroy(handle: number) => void ​

The on linear projectile destroy.

OnTargetProjectileObjectCreate(targetProjectile: TargetProjectileObject) => void ​

The on target projectile object create.

OnTargetProjectileObjectDestroy(targetProjectile: TargetProjectileObject) => void ​

The on target projectile object destroy.

OnLinearProjectileObjectCreate(linearProjectile: LinearProjectileObject) => void ​

The on linear projectile object create.

OnLinearProjectileObjectDestroy(linearProjectile: LinearProjectileObject) => void ​

The on linear projectile object destroy.

OnParticleCreate(particle: CreatedParticle) => void ​

The on particle create.

OnParticleUpdate(particle: UpdatedParticle) => void ​

The on particle update.

OnParticleUpdateEntity(particle: ParticleUpdateEntity) => void ​

The on particle update entity.

OnParticleUpdateForward(obj: UpdatedParticleForward) => void ​

The on particle update forward.

OnParticleUpdateFallback(obj: UpdatedParticleFallback) => void ​

The on particle update fallback.

OnParticleDestroy(particle: DestroyedParticle) => void ​

The on particle destroy.

OnStartSound(sound: OnStartSoundObject) => void ​

The on start sound.

OnActiveModifiersUpdate(obj: CDOTAModifierBuffTableEntry) => void ​

The on active modifiers update.