Generate better deprecation metadata (#68)

Author: tapple

generated/slua_default.d.luau

@@ -320,7 +320,7 @@ declare math: {
 declare os: {
   clock: () -> number,
   date: (s: string?, t: number?) -> (string | OsDateTime)?,
-  difftime: @deprecated (a: number, b: number?) -> number,
+  difftime: @[deprecated {reason='Same as a - b'}](a: number, b: number?) -> number,
   time: (t: OsDateTime?) -> number?,
 }
 
@@ -374,9 +374,9 @@ declare string: {
 
 declare table: {
   concat: (a: {string | number}, sep: string?, i: number?, j: number?) -> string,
-  foreach: @deprecated <K, V, R>(t: {[K]: V}, f: (key: K, value: V) -> R?) -> R?,
-  foreachi: @deprecated <V, R>(a: {V}, f: (index: number, value: V) -> R?) -> R?,
-  getn: @deprecated (a: {any}) -> number,
+  foreach: @[deprecated {reason='Use a for loop instead'}]<K, V, R>(t: {[K]: V}, f: (key: K, value: V) -> R?) -> R?,
+  foreachi: @[deprecated {reason='Use a for loop instead'}]<V, R>(a: {V}, f: (index: number, value: V) -> R?) -> R?,
+  getn: @[deprecated {use='#'}](a: {any}) -> number,
   maxn: (t: {any}) -> number,
   insert: (<V>(a: {V}, i: number, v: V) -> ())
     & (<V>(a: {V}, value: V) -> ()),
@@ -459,7 +459,7 @@ declare ll: {
   Acos: (Value: number) -> number,
   AddToLandBanList: (ID: uuid, Hours: number) -> (),
   AddToLandPassList: (ID: uuid, Hours: number) -> (),
-  AdjustDamage: @deprecated (Number: number, Damage: number) -> (),
+  AdjustDamage: @[deprecated {use='adjustDamage'}](Number: number, Damage: number) -> (),
   AdjustSoundVolume: (Volume: number) -> (),
   AgentInExperience: (AgentID: uuid) -> boolean,
   AllowInventoryDrop: (Flag: boolean | number) -> (),
@@ -503,24 +503,24 @@ declare ll: {
   DeleteSubString: (Source: string, Start: number, End: number) -> string,
   DerezObject: (ID: uuid, flags: number) -> boolean,
   DetachFromAvatar: () -> (),
-  DetectedDamage: @deprecated (Number: number) -> {any},
-  DetectedGrab: @deprecated (Number: number) -> vector,
-  DetectedGroup: @deprecated (Number: number) -> boolean,
-  DetectedKey: @deprecated (Number: number) -> uuid,
-  DetectedLinkNumber: @deprecated (Number: number) -> number,
-  DetectedName: @deprecated (Number: number) -> string,
-  DetectedOwner: @deprecated (Number: number) -> uuid,
-  DetectedPos: @deprecated (Number: number) -> vector,
-  DetectedRezzer: @deprecated (Number: number) -> uuid,
-  DetectedRot: @deprecated (Number: number) -> quaternion,
-  DetectedTouchBinormal: @deprecated (Index: number) -> vector,
-  DetectedTouchFace: @deprecated (Index: number) -> number,
-  DetectedTouchNormal: @deprecated (Index: number) -> vector,
-  DetectedTouchPos: @deprecated (Index: number) -> vector,
-  DetectedTouchST: @deprecated (Index: number) -> vector,
-  DetectedTouchUV: @deprecated (Index: number) -> vector,
-  DetectedType: @deprecated (Number: number) -> number,
-  DetectedVel: @deprecated (Number: number) -> vector,
+  DetectedDamage: @[deprecated {use='getDamage'}](Number: number) -> {any},
+  DetectedGrab: @[deprecated {use='getGrab'}](Number: number) -> vector,
+  DetectedGroup: @[deprecated {use='getGroup'}](Number: number) -> boolean,
+  DetectedKey: @[deprecated {use='getKey'}](Number: number) -> uuid,
+  DetectedLinkNumber: @[deprecated {use='getLinkNumber'}](Number: number) -> number,
+  DetectedName: @[deprecated {use='getName'}](Number: number) -> string,
+  DetectedOwner: @[deprecated {use='getOwner'}](Number: number) -> uuid,
+  DetectedPos: @[deprecated {use='getPos'}](Number: number) -> vector,
+  DetectedRezzer: @[deprecated {use='getRezzer'}](Number: number) -> uuid,
+  DetectedRot: @[deprecated {use='getRot'}](Number: number) -> quaternion,
+  DetectedTouchBinormal: @[deprecated {use='getTouchBinormal'}](Index: number) -> vector,
+  DetectedTouchFace: @[deprecated {use='getTouchFace'}](Index: number) -> number,
+  DetectedTouchNormal: @[deprecated {use='getTouchNormal'}](Index: number) -> vector,
+  DetectedTouchPos: @[deprecated {use='getTouchPos'}](Index: number) -> vector,
+  DetectedTouchST: @[deprecated {use='getTouchST'}](Index: number) -> vector,
+  DetectedTouchUV: @[deprecated {use='getTouchUV'}](Index: number) -> vector,
+  DetectedType: @[deprecated {use='getType'}](Number: number) -> number,
+  DetectedVel: @[deprecated {use='getVel'}](Number: number) -> vector,
   Dialog: (AvatarID: uuid, Text: string, Buttons: {string}, Channel: number) -> (),
   Die: () -> (),
   DumpList2String: (Source: list, Separator: string) -> string,
@@ -755,10 +755,10 @@ declare ll: {
   LoopSoundMaster: (Sound: string | uuid, Volume: number) -> (),
   LoopSoundSlave: (Sound: string | uuid, Volume: number) -> (),
   MD5String: (Text: string, Nonce: number) -> string,
-  MakeExplosion: @deprecated (Particles: number, Scale: number, Velocity: number, Lifetime: number, Arc: number, Texture: string | uuid, Offset: vector) -> (),
-  MakeFire: @deprecated (Particles: number, Scale: number, Velocity: number, Lifetime: number, Arc: number, Texture: string | uuid, Offset: vector) -> (),
-  MakeFountain: @deprecated (Particles: number, Scale: number, Velocity: number, Lifetime: number, Arc: number, Bounce: number, Texture: string | uuid, Offset: vector, Bounce_Offset: number) -> (),
-  MakeSmoke: @deprecated (Particles: number, Scale: number, Velocity: number, Lifetime: number, Arc: number, Texture: string | uuid, Offset: vector) -> (),
+  MakeExplosion: @[deprecated {use='ll.ParticleSystem'}](Particles: number, Scale: number, Velocity: number, Lifetime: number, Arc: number, Texture: string | uuid, Offset: vector) -> (),
+  MakeFire: @[deprecated {use='ll.ParticleSystem'}](Particles: number, Scale: number, Velocity: number, Lifetime: number, Arc: number, Texture: string | uuid, Offset: vector) -> (),
+  MakeFountain: @[deprecated {use='ll.ParticleSystem'}](Particles: number, Scale: number, Velocity: number, Lifetime: number, Arc: number, Bounce: number, Texture: string | uuid, Offset: vector, Bounce_Offset: number) -> (),
+  MakeSmoke: @[deprecated {use='ll.ParticleSystem'}](Particles: number, Scale: number, Velocity: number, Lifetime: number, Arc: number, Texture: string | uuid, Offset: vector) -> (),
   ManageEstateAccess: (Action: number, AvatarID: uuid) -> boolean,
   MapBeacon: (RegionName: string, Position: vector, Options: list) -> (),
   MapDestination: (RegionName: string, Position: vector, Direction: vector) -> (),
@@ -790,10 +790,10 @@ declare ll: {
   Pursue: (TargetID: uuid, Options: list) -> (),
   PushObject: (ObjectID: uuid, Impulse: vector, AngularImpulse: vector, Local: boolean | number) -> (),
   ReadKeyValue: (Key: string) -> uuid,
-  RefreshPrimURL: @deprecated () -> (),
+  RefreshPrimURL: @[deprecated {use='ll.SetPrimMediaParams'}]() -> (),
   RegionSay: (Channel: number, Text: string) -> (),
   RegionSayTo: (TargetID: uuid, Channel: number, Text: string) -> (),
-  ReleaseCamera: @deprecated (AvatarID: uuid) -> (),
+  ReleaseCamera: @[deprecated {use='ll.ClearCameraParams'}](AvatarID: uuid) -> (),
   ReleaseControls: () -> (),
   ReleaseURL: (URL: string) -> (),
   RemoteDataReply: @deprecated (ChannelID: uuid, MessageID: uuid, sData: string, iData: number) -> (),
@@ -875,7 +875,7 @@ declare ll: {
   SetLinkColor: (LinkNumber: number, Color: vector, Face: number) -> (),
   SetLinkGLTFOverrides: (link: number, face: number, options: list) -> (),
   SetLinkMedia: (Link: number, Face: number, Parameters: list) -> number,
-  SetLinkPrimitiveParams: @deprecated (LinkNumber: number, Parameters: list) -> (),
+  SetLinkPrimitiveParams: @[deprecated {use='ll.SetLinkPrimitiveParamsFast'}](LinkNumber: number, Parameters: list) -> (),
   SetLinkPrimitiveParamsFast: (LinkNumber: number, Parameters: list) -> (),
   SetLinkRenderMaterial: (LinkNumber: number, RenderMaterial: string | uuid, Face: number) -> (),
   SetLinkSitFlags: (LinkNumber: number, Flags: number) -> (),
@@ -891,8 +891,8 @@ declare ll: {
   SetPhysicsMaterial: (MaterialBits: number, GravityMultiplier: number, Restitution: number, Friction: number, Density: number) -> (),
   SetPos: (Position: vector) -> (),
   SetPrimMediaParams: (Face: number, MediaParameters: list) -> number,
-  SetPrimURL: @deprecated (URL: string) -> (),
-  SetPrimitiveParams: @deprecated (Parameters: list) -> (),
+  SetPrimURL: @[deprecated {use='ll.SetPrimMediaParams'}](URL: string) -> (),
+  SetPrimitiveParams: @[deprecated {use='ll.SetLinkPrimitiveParamsFast'}](Parameters: list) -> (),
   SetRegionPos: (Position: vector) -> boolean,
   SetRemoteScriptAccessPin: (PIN: number) -> (),
   SetRenderMaterial: (Material: string | uuid, Face: number) -> (),
@@ -920,8 +920,8 @@ declare ll: {
   SitOnLink: (AvatarID: uuid, LinkID: number) -> number,
   SitTarget: (Offset: vector, Rotation: quaternion) -> (),
   Sleep: (Time: number) -> (),
-  Sound: @deprecated (Sound: string | uuid, Volume: number, Queue: boolean | number, Loop: boolean | number) -> (),
-  SoundPreload: @deprecated (Sound: string | uuid) -> (),
+  Sound: @[deprecated {use='ll.PlaySound'}](Sound: string | uuid, Volume: number, Queue: boolean | number, Loop: boolean | number) -> (),
+  SoundPreload: @[deprecated {use='ll.PreloadSound'}](Sound: string | uuid) -> (),
   Sqrt: (Value: number) -> number,
   StartAnimation: (Animation: string) -> (),
   StartObjectAnimation: (Animation: string) -> (),
@@ -935,7 +935,7 @@ declare ll: {
   StringToBase64: (Text: string) -> string,
   StringTrim: (Text: string, TrimType: number) -> string,
   SubStringIndex: (Text: string, Sequence: string) -> number?,
-  TakeCamera: @deprecated (AvatarID: uuid) -> (),
+  TakeCamera: @[deprecated {use='ll.SetCameraParams'}](AvatarID: uuid) -> (),
   TakeControls: (Controls: number, Accept: boolean | number, PassOn: boolean | number) -> (),
   Tan: (Theta: number) -> number,
   Target: (Position: vector, Range: number) -> number,
@@ -967,8 +967,8 @@ declare ll: {
   Wind: (Offset: vector) -> vector,
   WorldPosToHUD: (world_pos: vector) -> vector,
   XorBase64: (Text1: string, Text2: string) -> string,
-  XorBase64Strings: @deprecated (Text1: string, Text2: string) -> string,
-  XorBase64StringsCorrect: @deprecated (Text1: string, Text2: string) -> string,
+  XorBase64Strings: @[deprecated {use='ll.XorBase64'}](Text1: string, Text2: string) -> string,
+  XorBase64StringsCorrect: @[deprecated {use='ll.XorBase64'}](Text1: string, Text2: string) -> string,
   sRGB2Linear: (srgb: vector) -> vector,
 }