Closed Thread
Results 1 to 7 of 7
Like Tree6Likes
  • 1 Post By ZorbaTHut
  • 5 Post By ZorbaTHut

  Click here to go to the first Rift Team post in this thread.   Thread: Official Addon Information Station

  1.   Click here to go to the next Rift Team post in this thread.   #1
    Rift Team
    Join Date
    Oct 2010
    Posts
    927

    Default Official Addon Information Station

    Welcome to the RIFT Addon API Development forum!


    The Addon API has been publicly available for about a year now. We've gone from being limited to raid frames and DPS meters all the way up to the present state, where the majority of requested addons can be developed and the API is stable. There's still a lot of work to be done, so mind the planar sawdust.

    If you need help on a player-created addon, many of the most popular addons have threads in this forum, and the authors are happy to hear feedback and suggestions. If you're an addon developer, or wish to become an addon developer, read on!

    This thread is intended as a central repository for Trion-provided information on the addon system. If you're a new developer, we recommend checking out the Addon Developer Resources thread.
    Last edited by ZorbaTHut; 09-24-2012 at 08:23 PM.

  2.   Click here to go to the next Rift Team post in this thread.   #2
    Rift Team
    Join Date
    Oct 2010
    Posts
    927

    Default Example Addons

    Here's a trio of examples to get you started.

    To install:

    * Download the addon you're interested in
    * Open Rift Public Test Shard
    * Click the "Addons" button
    * Click the "Open Addon Directory" button
    * Wait for the directory to open up
    * Extract the addon into that directory, preserving its path layout
    * Return to Rift
    * Click "Refresh"
    * Play the game!

    The actual extraction method depends on your operating system but we're going to assume that addon developers can figure that bit out.

    Trion Development Tools are a set of Lua-based utilities that we plan to improve as we go. Trion Development Tools also includes detailed documentation on the .toc format and is probably where you should start. Usage instructions: "/dump" will show the documentation list, with "/dump detail" giving function and parameter descriptions. The detailed output is far too long to fit in the chat buffer - you'll want to use "/log" to turn on the disk chat log first. "/eventlog" will toggle a streaming log of events to the console (minus the extremely spammy Update.Begin()/Update.End() events), and can be used to substring-filter events as well ("/eventlog Buff" to only show events with Buff in the name.) Will also write a full log of events to its SavedVariables file, which you can browse with a text editor.

    Zorba's Buff Bars is a set of modified buff bars in a drastically different style, and is provided as an example of a realistic mod. We'll be fleshing it out as we add functionality.

    LibUnitChange is a library to take the somewhat-obtuse Event.Unit.Change.* hierarchy and turn it into something more generally useful. It's not quite as powerful as direct access to that hierarchy, but it's more likely to be what you want.

    All of our examples can be downloaded at http://webcdn.triongames.com/addons/assets/addon/. They are provided under a 2-clause BSD license, which is included in the zip files.
    Last edited by ZorbaTHut; 05-08-2015 at 02:13 PM.

  3.   Click here to go to the next Rift Team post in this thread.   #3
    Rift Team
    Join Date
    Oct 2010
    Posts
    927

    Default Addon Documentation

    An API summary is available along with detailed usage instructions. Rift API functions are self-documenting via Inspect.Documentation and will also dump their documentation if used incorrectly. Note that this is the exact output that is generated by the Trion Development Tools addon via "/dump" and "/dump detail".

    Code:
    Basic globals:
    	UI.Context
    	UI.CreateContext
    	UI.CreateFrame
    	UI.Frame
    	UIParent.Event.Move
    	UIParent.Event.Size
    	_VERSION
    	assert
    	bit.arshift
    	bit.band
    	bit.bnot
    	bit.bor
    	bit.bswap
    	bit.bxor
    	bit.lshift
    	bit.rol
    	bit.ror
    	bit.rshift
    	bit.tobit
    	bit.tohex
    	collectgarbage
    	coroutine.create
    	coroutine.resume
    	coroutine.running
    	coroutine.status
    	coroutine.wrap
    	coroutine.yield
    	debug.traceback
    	dump
    	error
    	gcinfo
    	getfenv
    	getmetatable
    	ipairs
    	load
    	loadstring
    	math.abs
    	math.acos
    	math.asin
    	math.atan
    	math.atan2
    	math.ceil
    	math.cos
    	math.cosh
    	math.deg
    	math.exp
    	math.floor
    	math.fmod
    	math.frexp
    	math.huge
    	math.ldexp
    	math.log
    	math.log10
    	math.max
    	math.min
    	math.modf
    	math.pi
    	math.pow
    	math.rad
    	math.random
    	math.randomseed
    	math.sin
    	math.sinh
    	math.sqrt
    	math.tan
    	math.tanh
    	math.tau
    	newproxy
    	next
    	os.date
    	os.difftime
    	os.time
    	pairs
    	pcall
    	print
    	rawequal
    	rawget
    	rawlen
    	rawset
    	select
    	setfenv
    	setmetatable
    	string.byte
    	string.char
    	string.find
    	string.format
    	string.gmatch
    	string.gsub
    	string.len
    	string.lower
    	string.match
    	string.rep
    	string.reverse
    	string.sub
    	string.upper
    	table.concat
    	table.foreach
    	table.foreachi
    	table.getn
    	table.insert
    	table.maxn
    	table.pack
    	table.remove
    	table.sort
    	table.unpack
    	tonumber
    	tostring
    	type
    	unpack
    	xpcall
    	zlib.BEST_COMPRESSION
    	zlib.BEST_SPEED
    	zlib._COPYRIGHT
    	zlib._DESCRIPTION
    	zlib._VERSION
    	zlib.deflate
    	zlib.inflate
     
    Inspectors:
    	Inspect.Ability.New.Detail
    	Inspect.Ability.New.List
    	Inspect.Achievement.Category.Detail
    	Inspect.Achievement.Category.List
    	Inspect.Achievement.Detail
    	Inspect.Achievement.List
    	Inspect.Addon.Cpu
    	Inspect.Addon.Current
    	Inspect.Addon.Detail
    	Inspect.Addon.List
    	Inspect.Attunement.Progress
    	Inspect.Auction.Detail
    	Inspect.Buff.Detail
    	Inspect.Buff.List
    	Inspect.Console.Detail
    	Inspect.Console.List
    	Inspect.Currency.Category.Detail
    	Inspect.Currency.Category.List
    	Inspect.Currency.Detail
    	Inspect.Currency.List
    	Inspect.Cursor
    	Inspect.Dimension.Layout.Detail
    	Inspect.Dimension.Layout.List
    	Inspect.Documentation
    	Inspect.Event.List
    	Inspect.Experience
    	Inspect.Faction.Detail
    	Inspect.Faction.List
    	Inspect.Guild.Bank.Coin
    	Inspect.Guild.Bank.Detail
    	Inspect.Guild.Bank.List
    	Inspect.Guild.Motd
    	Inspect.Guild.Rank.Detail
    	Inspect.Guild.Rank.List
    	Inspect.Guild.Roster.Detail
    	Inspect.Guild.Roster.List
    	Inspect.Interaction
    	Inspect.Item.Detail
    	Inspect.Item.Find
    	Inspect.Item.List
    	Inspect.Mail.Detail
    	Inspect.Mail.List
    	Inspect.Map.Detail
    	Inspect.Map.List
    	Inspect.Map.Monitor
    	Inspect.Message.Accept.Check
    	Inspect.Message.Accept.List
    	Inspect.Mouse
    	Inspect.Pvp.History
    	Inspect.Pvp.Prestige
    	Inspect.Quest.Complete
    	Inspect.Quest.Detail
    	Inspect.Quest.List
    	Inspect.Queue.Handler
    	Inspect.Queue.Status
    	Inspect.Role.List
    	Inspect.Setting.Detail
    	Inspect.Setting.List
    	Inspect.Shard
    	Inspect.Social.Friend.Detail
    	Inspect.Social.Friend.List
    	Inspect.Social.Ignore.Detail
    	Inspect.Social.Ignore.List
    	Inspect.Stat
    	Inspect.Storage.Used
    	Inspect.System.Error.Detail
    	Inspect.System.Language
    	Inspect.System.Secure
    	Inspect.System.Version
    	Inspect.System.Watchdog
    	Inspect.TEMPORARY.Experience
    	Inspect.TEMPORARY.Role
    	Inspect.Time.Frame
    	Inspect.Time.Real
    	Inspect.Time.Server
    	Inspect.Title.Category.Detail
    	Inspect.Title.Category.List
    	Inspect.Title.Detail
    	Inspect.Title.List
    	Inspect.Tooltip
    	Inspect.Unit.Castbar
    	Inspect.Unit.Detail
    	Inspect.Unit.List
    	Inspect.Unit.Lookup
    	Inspect.Zone.Detail
     
    Commands:
    	Command.Auction.Bid
    	Command.Auction.Cancel
    	Command.Auction.Post
    	Command.Auction.Scan
    	Command.Buff.Cancel
    	Command.Buff.Describe
    	Command.Console.Display
    	Command.Cursor
    	Command.Dimension.Layout.Pickup
    	Command.Dimension.Layout.Place
    	Command.Dimension.Layout.Select
    	Command.Event.Attach
    	Command.Event.Detach
    	Command.Guild.Bank.Deposit
    	Command.Guild.Bank.Purchase
    	Command.Guild.Bank.Withdraw
    	Command.Guild.Log.Request
    	Command.Guild.Motd
    	Command.Guild.Roster.Demote
    	Command.Guild.Roster.Kick
    	Command.Guild.Roster.Note
    	Command.Guild.Roster.NoteOfficer
    	Command.Guild.Roster.Promote
    	Command.Guild.Wall.Delete
    	Command.Guild.Wall.Post
    	Command.Guild.Wall.Request
    	Command.Item.Destroy
    	Command.Item.Move
    	Command.Item.Split
    	Command.Item.Standard.Drag
    	Command.Item.Standard.Drop
    	Command.Item.Standard.Left
    	Command.Item.Standard.Right
    	Command.Mail.Delete
    	Command.Mail.Open
    	Command.Mail.Pay
    	Command.Mail.Return
    	Command.Mail.Send
    	Command.Mail.Spam
    	Command.Mail.Take
    	Command.Map.Monitor
    	Command.Message.Accept
    	Command.Message.Broadcast
    	Command.Message.Reject
    	Command.Message.Send
    	Command.Quest.Abandon
    	Command.Quest.Share
    	Command.Quest.Track
    	Command.Quest.Watch
    	Command.Queue.Handler
    	Command.Slash.Register
    	Command.Social.Friend.Add
    	Command.Social.Friend.Note
    	Command.Social.Friend.Remove
    	Command.Social.Ignore.Add
    	Command.Social.Ignore.Note
    	Command.Social.Ignore.Remove
    	Command.Storage.Clear
    	Command.Storage.Get
    	Command.Storage.List
    	Command.Storage.Set
    	Command.System.Flash
    	Command.System.Strict
    	Command.System.Texture.Record
    	Command.System.Watchdog.Quiet
    	Command.Title.Prefix
    	Command.Title.Suffix
    	Command.Tooltip
    	Command.UI.Error
    	Command.Unit.Menu
     
    Utilities:
    	Utility.Auction.Cost
    	Utility.Dispatch
    	Utility.Event.Create
    	Utility.Item.Slot.All
    	Utility.Item.Slot.Bank
    	Utility.Item.Slot.Equipment
    	Utility.Item.Slot.Guild
    	Utility.Item.Slot.Inventory
    	Utility.Item.Slot.Parse
    	Utility.Item.Slot.Quest
    	Utility.Item.Slot.Vault
    	Utility.Item.Slot.Wardrobe
    	Utility.Mail.Cost
    	Utility.Matrix.Create
    	Utility.Message.Limits
    	Utility.Message.Size
    	Utility.Serialize.Full
    	Utility.Serialize.Inline
    	Utility.Storage.Checksum
    	Utility.Storage.Limits
    	Utility.Storage.Size
    	Utility.Type
    	Utility.Unit.Availability
     
    Native frames:
    	UI.Native.Ability
    	UI.Native.Accolade
    	UI.Native.Achievement
    	UI.Native.AchievementPopup
    	UI.Native.Adventure
    	UI.Native.Ascend
    	UI.Native.Attunement
    	UI.Native.Auction
    	UI.Native.Bag
    	UI.Native.BagBank1
    	UI.Native.BagBank2
    	UI.Native.BagBank3
    	UI.Native.BagBank4
    	UI.Native.BagBank5
    	UI.Native.BagBank6
    	UI.Native.BagBank7
    	UI.Native.BagBank8
    	UI.Native.BagInventory1
    	UI.Native.BagInventory2
    	UI.Native.BagInventory3
    	UI.Native.BagInventory4
    	UI.Native.BagInventory5
    	UI.Native.BagInventory6
    	UI.Native.BagInventory7
    	UI.Native.Bank
    	UI.Native.BankGuild
    	UI.Native.BarBottom1
    	UI.Native.BarBottom2
    	UI.Native.BarBottom3
    	UI.Native.BarBottom4
    	UI.Native.BarBottom5
    	UI.Native.BarBottom6
    	UI.Native.BarMain
    	UI.Native.BarPet
    	UI.Native.BarSide1
    	UI.Native.BarSide2
    	UI.Native.BarSide3
    	UI.Native.BarSide4
    	UI.Native.BarTemporary
    	UI.Native.Breath
    	UI.Native.Buffbar
    	UI.Native.Castbar
    	UI.Native.Character
    	UI.Native.Chronicle
    	UI.Native.Coinlock
    	UI.Native.Console1
    	UI.Native.Console2
    	UI.Native.Console3
    	UI.Native.Console4
    	UI.Native.Console5
    	UI.Native.Console6
    	UI.Native.Console7
    	UI.Native.ConsoleSetting
    	UI.Native.Crafting
    	UI.Native.Ctf
    	UI.Native.Guest
    	UI.Native.Guild
    	UI.Native.GuildCharter
    	UI.Native.GuildFinder
    	UI.Native.Import
    	UI.Native.Keybind
    	UI.Native.Layout
    	UI.Native.Leaderboard
    	UI.Native.Lfg
    	UI.Native.Loot
    	UI.Native.Macro
    	UI.Native.MacroIcon
    	UI.Native.MacroSlash
    	UI.Native.Mail
    	UI.Native.MailRead
    	UI.Native.MapMain
    	UI.Native.MapMini
    	UI.Native.MechanicPlayer
    	UI.Native.MechanicTarget
    	UI.Native.Mentor
    	UI.Native.Menu
    	UI.Native.MessageEvent
    	UI.Native.MessageStandard
    	UI.Native.MessageText
    	UI.Native.MessageWarfront
    	UI.Native.MessageZone
    	UI.Native.Notification
    	UI.Native.Notify
    	UI.Native.PortraitFocus
    	UI.Native.PortraitParty1
    	UI.Native.PortraitParty1Pet
    	UI.Native.PortraitParty2
    	UI.Native.PortraitParty2Pet
    	UI.Native.PortraitParty3
    	UI.Native.PortraitParty3Pet
    	UI.Native.PortraitParty4
    	UI.Native.PortraitParty4Pet
    	UI.Native.PortraitPet
    	UI.Native.PortraitPlayer
    	UI.Native.PortraitTarget
    	UI.Native.PortraitTargetTarget
    	UI.Native.Quest
    	UI.Native.QuestStickies
    	UI.Native.Question
    	UI.Native.Raid
    	UI.Native.RaidGroup1
    	UI.Native.RaidGroup1Pet
    	UI.Native.RaidGroup2
    	UI.Native.RaidGroup2Pet
    	UI.Native.RaidGroup3
    	UI.Native.RaidGroup3Pet
    	UI.Native.RaidGroup4
    	UI.Native.RaidGroup4Pet
    	UI.Native.RaidParty
    	UI.Native.RaidPartyPet
    	UI.Native.Reactive
    	UI.Native.Recall
    	UI.Native.Respec
    	UI.Native.Rift
    	UI.Native.Roll1
    	UI.Native.Roll2
    	UI.Native.Roll3
    	UI.Native.Roll4
    	UI.Native.Setting
    	UI.Native.Social
    	UI.Native.Soul
    	UI.Native.Split
    	UI.Native.Streaming
    	UI.Native.Ticket
    	UI.Native.Tip
    	UI.Native.TipAlert
    	UI.Native.Tooltip
    	UI.Native.TooltipAnchor
    	UI.Native.Trade
    	UI.Native.Tray
    	UI.Native.TraySocial
    	UI.Native.Treasure
    	UI.Native.Trial
    	UI.Native.Upgrade
    	UI.Native.Warfront
    	UI.Native.WarfrontLeaderboard
    	UI.Native.World
     
    Global events:
    	Event.Ability.New.Add
    	Event.Ability.New.Cooldown.Begin
    	Event.Ability.New.Cooldown.End
    	Event.Ability.New.Range.False
    	Event.Ability.New.Range.True
    	Event.Ability.New.Remove
    	Event.Ability.New.Target
    	Event.Ability.New.Usable.False
    	Event.Ability.New.Usable.True
    	Event.Achievement.Complete
    	Event.Achievement.Update
    	Event.Addon.Load.Begin
    	Event.Addon.Load.End
    	Event.Addon.SavedVariables.Load.Begin
    	Event.Addon.SavedVariables.Load.End
    	Event.Addon.SavedVariables.Save.Begin
    	Event.Addon.SavedVariables.Save.End
    	Event.Addon.Shutdown.Begin
    	Event.Addon.Shutdown.End
    	Event.Addon.Startup.End
    	Event.Attunement.Progress.Accumulated
    	Event.Attunement.Progress.Available
    	Event.Attunement.Progress.Rested
    	Event.Attunement.Progress.Spent
    	Event.Auction.Scan
    	Event.Buff.Add
    	Event.Buff.Change
    	Event.Buff.Description
    	Event.Buff.Remove
    	Event.Chat.Notify
    	Event.Chat.Npc
    	Event.Combat.Damage
    	Event.Combat.Death
    	Event.Combat.Dodge
    	Event.Combat.Heal
    	Event.Combat.Immune
    	Event.Combat.Miss
    	Event.Combat.Parry
    	Event.Combat.Resist
    	Event.Currency
    	Event.Cursor
    	Event.Dimension.Layout.Add
    	Event.Dimension.Layout.Remove
    	Event.Dimension.Layout.Update
    	Event.Experience.Accumulated
    	Event.Experience.Rested
    	Event.Faction.Notoriety
    	Event.Guild.Bank.Change
    	Event.Guild.Bank.Coin
    	Event.Guild.Log
    	Event.Guild.Motd
    	Event.Guild.Rank
    	Event.Guild.Roster.Add
    	Event.Guild.Roster.Detail.Level
    	Event.Guild.Roster.Detail.Note
    	Event.Guild.Roster.Detail.NoteOfficer
    	Event.Guild.Roster.Detail.Rank
    	Event.Guild.Roster.Detail.Status
    	Event.Guild.Roster.Detail.Zone
    	Event.Guild.Roster.Remove
    	Event.Guild.Wall
    	Event.Interaction
    	Event.Item.Slot
    	Event.Item.Update
    	Event.Mail
    	Event.Map.Add
    	Event.Map.Change
    	Event.Map.Detail.Coord
    	Event.Map.Remove
    	Event.Message.Receive
    	Event.Mouse.Move
    	Event.Pvp.History.Favor
    	Event.Pvp.History.Kill.Today
    	Event.Pvp.Prestige.Accumulated
    	Event.Pvp.Prestige.Rank
    	Event.Quest.Abandon
    	Event.Quest.Accept
    	Event.Quest.Change
    	Event.Quest.Complete
    	Event.Queue.Status
    	Event.Slash	(category for dynamically-created events)
    	Event.Slash.addonerror
    	Event.Slash.dump
    	Event.Slash.eventlog
    	Event.Slash.framecap
    	Event.Slash.layout
    	Event.Social.Friend
    	Event.Social.Ignore
    	Event.Stat
    	Event.Storage.Get
    	Event.Storage.List
    	Event.System.Error
    	Event.System.Secure.Enter
    	Event.System.Secure.Leave
    	Event.System.Texture
    	Event.System.Update.Begin
    	Event.System.Update.End
    	Event.TEMPORARY.Experience
    	Event.TEMPORARY.Role
    	Event.Title.Add
    	Event.Tooltip
    	Event.Unit.Add
    	Event.Unit.Availability.Full
    	Event.Unit.Availability.None
    	Event.Unit.Availability.Partial
    	Event.Unit.Castbar
    	Event.Unit.Detail.Absorb
    	Event.Unit.Detail.Afk
    	Event.Unit.Detail.Aggro
    	Event.Unit.Detail.Blocked
    	Event.Unit.Detail.Charge
    	Event.Unit.Detail.ChargeMax
    	Event.Unit.Detail.Combat
    	Event.Unit.Detail.Combo
    	Event.Unit.Detail.Coord
    	Event.Unit.Detail.Energy
    	Event.Unit.Detail.EnergyMax
    	Event.Unit.Detail.Guild
    	Event.Unit.Detail.Health
    	Event.Unit.Detail.HealthCap
    	Event.Unit.Detail.HealthMax
    	Event.Unit.Detail.Level
    	Event.Unit.Detail.LocationName
    	Event.Unit.Detail.Mana
    	Event.Unit.Detail.ManaMax
    	Event.Unit.Detail.Mark
    	Event.Unit.Detail.Mentoring
    	Event.Unit.Detail.Name
    	Event.Unit.Detail.Offline
    	Event.Unit.Detail.Planar
    	Event.Unit.Detail.PlanarMax
    	Event.Unit.Detail.Power
    	Event.Unit.Detail.PublicSize
    	Event.Unit.Detail.Pvp
    	Event.Unit.Detail.Radius
    	Event.Unit.Detail.Ready
    	Event.Unit.Detail.Role
    	Event.Unit.Detail.Tagged
    	Event.Unit.Detail.TitlePrefixId
    	Event.Unit.Detail.TitlePrefixName
    	Event.Unit.Detail.TitleSuffixId
    	Event.Unit.Detail.TitleSuffixName
    	Event.Unit.Detail.Vitality
    	Event.Unit.Detail.Warfront
    	Event.Unit.Detail.Zone
    	Event.Unit.Remove
     
    UI:
    	Layout:
    		Members:
    			EventAttach
    			EventDetach
    			EventList
    			EventMacroGet
    			EventMacroSet
    			GetBottom
    			GetBounds
    			GetEventTable
    			GetHeight
    			GetLeft
    			GetName
    			GetOwner
    			GetRight
    			GetTop
    			GetType
    			GetWidth
    			ReadAll
    			ReadHeight
    			ReadPoint
    			ReadWidth
    		Events:
    			Move
    			Size
    	Native: Inherits from Layout
    		Members:
    			GetLayer
    			GetLoaded
    			GetSecureMode
    			GetStrata
    			GetStrataList
    			SetLayer
    			SetStrata
    		Events:
    			Layer
    			Loaded
    			Strata
    	Element: Inherits from Layout
    		Members:
    			GetAlpha
    			GetBackgroundColor
    			GetChildren
    			GetKeyFocus
    			GetMouseMasking
    			GetVisible
    			SetAlpha
    			SetBackgroundColor
    			SetKeyFocus
    			SetMouseMasking
    			SetVisible
    		Events:
    			KeyDown
    			KeyFocusGain
    			KeyFocusLoss
    			KeyRepeat
    			KeyType
    			KeyUp
    			LeftClick
    			LeftDown
    			LeftUp
    			LeftUpoutside
    			MiddleClick
    			MiddleDown
    			MiddleUp
    			MiddleUpoutside
    			Mouse4Click
    			Mouse4Down
    			Mouse4Up
    			Mouse4Upoutside
    			Mouse5Click
    			Mouse5Down
    			Mouse5Up
    			Mouse5Upoutside
    			MouseIn
    			MouseMove
    			MouseOut
    			RightClick
    			RightDown
    			RightUp
    			RightUpoutside
    			WheelBack
    			WheelForward
    	Frame: Inherits from Element
    		Members:
    			ClearAll
    			ClearHeight
    			ClearPoint
    			ClearWidth
    			GetLayer
    			GetMouseoverUnit
    			GetParent
    			GetSecureMode
    			GetStrata
    			GetStrataList
    			SetAllPoints
    			SetHeight
    			SetLayer
    			SetMouseoverUnit
    			SetParent
    			SetPoint
    			SetSecureMode
    			SetStrata
    			SetWidth
    		Events:
    			Layer
    			Strata
    	Context: Inherits from Frame
    		Members:
    			(No extra members)
    		Events:
    			(No extra events)
    	Canvas: Inherits from Frame
    		Members:
    			GetShape
    			SetShape
    		Events:
    			(No extra events)
    	Mask: Inherits from Frame
    		Members:
    			GetShape
    			SetShape
    		Events:
    			(No extra events)
    	Text: Inherits from Frame
    		Members:
    			GetEffectBlur
    			GetEffectGlow
    			GetFont
    			GetFontColor
    			GetFontSize
    			GetText
    			GetWordwrap
    			SetEffectBlur
    			SetEffectGlow
    			SetFont
    			SetFontColor
    			SetFontSize
    			SetText
    			SetWordwrap
    		Events:
    			(No extra events)
    	Texture: Inherits from Frame
    		Members:
    			GetTexture
    			GetTextureHeight
    			GetTextureWidth
    			SetTexture
    		Events:
    			(No extra events)
    	RiftButton: Inherits from Frame
    		Members:
    			GetEnabled
    			GetSkin
    			GetText
    			SetEnabled
    			SetSkin
    			SetText
    		Events:
    			LeftPress
    	RiftCheckbox: Inherits from Frame
    		Members:
    			GetChecked
    			GetEnabled
    			SetChecked
    			SetEnabled
    		Events:
    			CheckboxChange
    	RiftScrollbar: Inherits from Frame
    		Members:
    			GetEnabled
    			GetOrientation
    			GetPosition
    			GetRange
    			GetThickness
    			Nudge
    			NudgeDown
    			NudgeUp
    			SetEnabled
    			SetOrientation
    			SetPosition
    			SetRange
    			SetThickness
    		Events:
    			ScrollbarChange
    			ScrollbarGrab
    			ScrollbarRelease
    	RiftSlider: Inherits from Frame
    		Members:
    			GetEnabled
    			GetPosition
    			GetRange
    			SetEnabled
    			SetPosition
    			SetRange
    		Events:
    			SliderChange
    			SliderGrab
    			SliderRelease
    	RiftTextfield: Inherits from Frame
    		Members:
    			GetCursor
    			GetSelection
    			GetSelectionText
    			GetText
    			SetCursor
    			SetSelection
    			SetText
    		Events:
    			TextfieldChange
    			TextfieldSelect
    	RiftWindow: Inherits from Frame
    		Members:
    			GetBorder
    			GetContent
    			GetController
    			GetTitle
    			GetTrimDimensions
    			SetController
    			SetTitle
    		Events:
    			(No extra events)
     
    Frame events:
    	Event.UI.Button.Left.Press
    	Event.UI.Checkbox.Change
    	Event.UI.Input.Key.Down
    	Event.UI.Input.Key.Focus.Gain
    	Event.UI.Input.Key.Focus.Loss
    	Event.UI.Input.Key.Repeat
    	Event.UI.Input.Key.Type
    	Event.UI.Input.Key.Up
    	Event.UI.Input.Mouse.Cursor.In
    	Event.UI.Input.Mouse.Cursor.Move
    	Event.UI.Input.Mouse.Cursor.Out
    	Event.UI.Input.Mouse.Left.Click
    	Event.UI.Input.Mouse.Left.Down
    	Event.UI.Input.Mouse.Left.Up
    	Event.UI.Input.Mouse.Left.Upoutside
    	Event.UI.Input.Mouse.Middle.Click
    	Event.UI.Input.Mouse.Middle.Down
    	Event.UI.Input.Mouse.Middle.Up
    	Event.UI.Input.Mouse.Middle.Upoutside
    	Event.UI.Input.Mouse.Mouse4.Click
    	Event.UI.Input.Mouse.Mouse4.Down
    	Event.UI.Input.Mouse.Mouse4.Up
    	Event.UI.Input.Mouse.Mouse4.Upoutside
    	Event.UI.Input.Mouse.Mouse5.Click
    	Event.UI.Input.Mouse.Mouse5.Down
    	Event.UI.Input.Mouse.Mouse5.Up
    	Event.UI.Input.Mouse.Mouse5.Upoutside
    	Event.UI.Input.Mouse.Right.Click
    	Event.UI.Input.Mouse.Right.Down
    	Event.UI.Input.Mouse.Right.Up
    	Event.UI.Input.Mouse.Right.Upoutside
    	Event.UI.Input.Mouse.Wheel.Back
    	Event.UI.Input.Mouse.Wheel.Forward
    	Event.UI.Layout.Layer
    	Event.UI.Layout.Move
    	Event.UI.Layout.Size
    	Event.UI.Layout.Strata
    	Event.UI.Native.Loaded
    	Event.UI.Scrollbar.Change
    	Event.UI.Scrollbar.Grab
    	Event.UI.Scrollbar.Release
    	Event.UI.Slider.Change
    	Event.UI.Slider.Grab
    	Event.UI.Slider.Release
    	Event.UI.Textfield.Change
    	Event.UI.Textfield.Select
     
    Parameter types:
    	Canvas
    	Context
    	Element
    	Frame
    	Layout
    	Mask
    	Native
    	RiftButton
    	RiftCheckbox
    	RiftScrollbar
    	RiftSlider
    	RiftTextfield
    	RiftWindow
    	Text
    	Texture
    	ability
    	achievement
    	achievementcategory
    	auction
    	boolean
    	buff
    	callbackfunction
    	console
    	currencycategory
    	dimensionitem
    	error
    	eventFrame
    	eventGlobal
    	faction
    	frameEventTable
    	function
    	function/nil
    	function/string
    	function/string/nil
    	guildrank
    	guildwall
    	handleEventFrame
    	handleEventGlobal
    	item
    	itemtype
    	location
    	mail
    	nil
    	number
    	number/nil
    	quest
    	role
    	slot
    	string
    	string/nil
    	table
    	title
    	titlecategory
    	unit
    	variant
    	zone
    If you're interested in PTS documentation, here is the summary and here are the details. Note that PTS functionality may change by the time it reaches live servers.

    Rift addon documentation is licensed under a Creative Commons Attribution 3.0 Unported License (CC-BY 3.0).

    Don't see a function you need? Come tell us about it in the Suggestions Thread.
    Last edited by ZorbaTHut; 09-18-2013 at 02:30 PM.

  4.   Click here to go to the next Rift Team post in this thread.   #4
    Rift Team
    Join Date
    Oct 2010
    Posts
    927

    Default Automatic Error Reports

    Every addon developer will automatically receive daily reports about addon errors. These reports compile the last week's worth of data and give info on the most common errors the users of your addons have experienced.

    They'll look something like this:

    Official Addon Information Station-errors_wildtide.jpg

    (Thanks to Wildtide for volunteering to show his errors publicly :) )

    The error reporting system will filter out uncommon errors and will also show only the five most common errors for a specific addon version. If you've got an addon showing less than five errors, but with only a small fraction of your errors reported, let me know and I can dig out information on the rest. If you don't have *any* errors that fall under those categories you just won't receive emails (congratulations on writing a bug-free addon!)

    If you're not interested in receiving regular error reports, either reply to the daily report, email Addons@RIFTgame.com and request an unsubscribe, or send me a private message on the forums with your email address.

    This should provide addon developers with the information they need to make stable and functional addons for the whole community!
    Last edited by ZorbaTHut; 09-24-2012 at 08:33 PM.

  5.   Click here to go to the next Rift Team post in this thread.   #5
    Rift Team
    Join Date
    Oct 2010
    Posts
    927

    Default Upcoming Breaking Changes

    Every once in a while, we need to go back to a feature or an interface and change it. Usually we can do this without breaking anyone's code. Sometimes we don't have a choice, and things will break.

    When we can, we'll be giving you ample warning about upcoming breaking changes. This top post will list all of those upcoming issues. Please keep these items in mind! If you use a function that's already slated for removal, and then it's removed, your addon will stop working.

    Discussion should go in the Discussion Thread.

    UPCOMING BREAKING CHANGES:

    2.3 BREAKING CHANGES:

    * Macros will no longer be supported in :EventAttach() and :EventDetach(). We've added new functions, :EventMacroSet() and :EventMacroGet(), to make make handling far more easily. This is now a compatibility-mode-only feature and will be removed entirely in 2.3.

    2.3 HOTFIX 1 BREAKING CHANGES:

    * Item descriptors gain a new type, "Vault". Accessible through Utility.Item.Slot.Vault() as you'd expect - first number is the vault number, second number is the slot within that vault. The old "main bank" descriptors will still work as function parameters, but the Item events won't generate "main bank" descriptors anymore, they'll be generating the new Vault descriptor. At this point, any addon expecting main bank descriptors, or any addon that is unable to deal with the new Vault descriptors, will break.

    2.4 BREAKING CHANGES:

    * The old event system will be removed in its entirety! THIS WILL BREAK ALL UNPREPARED ADDONS. Fix yours now! The rationale and changes can be read at http://forums.riftgame.com/rift-gene...-redesign.html .

    * Inspect.Unit.Detail()'s titlePrefixName and titleSuffixName are now deprecated and will be removed in the future, along with the Event equivalents.

    * Inspect.TEMPORARY.Experience() and Event.TEMPORARY.Experience will be removed. Inspect.Experience() and Event.Experience should provide all the needed functionality.

    * Main bank slot descriptors will be removed entirely.

    EVENTUAL BREAKING CHANGES WITHOUT A PERMANENT SOLUTION, NOT YET PLANNED FOR REMOVAL:

    * Inspect.TEMPORARY.Role() and Event.TEMPORARY.Role will be removed once replacements exist.

    Old breaking changes, saved for posterity and ease of porting old addons:

    2.0 BREAKING CHANGES:

    Inspect.Unit.Detail().comboUnit/Event.Unit.Detail.ComboUnit
    - As combo points are no longer associated with any specific unit, this functionality is no longer needed. Event.Unit.Detail.ComboUnit still exists within the addon API but will no longer fire. It will be removed entirely in 2.1.

    2.1 BREAKING CHANGES:

    The deprecated versions of these functions will be removed entirely, along with 1.9 Compatibility Mode. Any addon that still makes use of this functionality will need code changes.

    print_raw()
    - See Command.Console.Display() - some code changes may be necessary.

    Inspect.Ability.List()
    Inspect.Ability.Detail()
    - Use Inspect.Ability.New.*() instead.

    Inspect.Achievement.Detail().faction
    - Use Inspect.Achievement.Detail().alliance instead.

    Inspect.Buff.Detail().ability
    Inspect.Castbar().ability
    - Use Inspect.*().abilityNew instead.

    Inspect.Unit.Detail().comboUnit/Event.Unit.Detail.ComboUnit
    - As combo points are no longer associated with any specific unit, this functionality is no longer needed, and these functions will be removed entirely.

    Inspect.Item.Detail().requiredFactionName
    Inspect.Unit.Detail().factionName
    - Use Inspect.Faction.Detail(Inspect.Item.Detail().requi redFaction / Inspect.Unit.Detail().faction).name instead.

    Inspect.Unit.Detail().titlePrefix/titleSuffix
    - Use Inspect.Title.Detail(Inspect.Unit.Detail().titlePr efixId/titleSuffixId).name.

    Event.Ability.Add
    Event.Ability.Remove
    Event.Ability.Cooldown.Begin
    Event.Ability.Cooldown.End
    Event.Ability.Target
    Event.Ability.Range.True
    Event.Ability.Range.False
    Event.Ability.Usable.True
    Event.Ability.Usable.False
    - Use Event.Ability.New.* instead.

    Event.Unit.Available
    Event.Unit.Unavailable
    - See Event.Unit.Availability.* - some code changes may be necessary.

    Event.Unit.Detail.TitlePrefix
    Event.Unit.Detail.TitleSuffix
    - Use Event.Unit.Detail.TitlePrefixId/TitleSuffixId, then use Inspect.Title.Detail() to look up the localized name.

    RiftButton/RiftCheckbox/RiftSlider/RiftTextfield/RiftWindow:GetDefaultWidth()/GetDefaultHeight()
    - Frames now initialize themselves with their default sizes automatically.

    RiftButton/RiftCheckbox/RiftSlider/RiftTextfield/RiftWindow:ResizeToDefault()
    - Clearing a frame's explicitly-set size will now return it to default.

    Text:ResizeToText()/GetFullWidth()/GetFullHeight()
    - Similar to other frames, a text's default size is considered the size that fits the text perfectly. Unless constrained via SetPoint, a textfield's height will adjust automatically if its width changes.

    Texture:ResizeToTexture()
    - Similar to other frames, a texture's default size is considered the texture's native resolution, and a texture will resize itself automatically if its size has not been manually set.
    Last edited by ZorbaTHut; 06-07-2013 at 10:48 PM.

  6.   Click here to go to the next Rift Team post in this thread.   #6
    Rift Team
    Join Date
    Oct 2010
    Posts
    927

    Default RIFT UI Add-On Policy

    RIFT™ User Interface Add-On Policy


    Trion Worlds, Inc. (“Trion”) has created this policy to formalize the development and distribution of RIFT™ user interface add-ons created by members of the player community (referred to hereafter as "Add-Ons"). The purpose of this policy is to ensure the integrity of RIFT and to continue promoting an enjoyable gaming environment for our players. Failure to abide by the policy may result in measures up to and including formal legal action.
    1. All Add-Ons must abide by the RIFT End User License Agreement and Trion’s Terms of Use.
    2. All Add-Ons, including all versions thereof and all features therein, must be distributed free of charge. Further, Developers may not charge money, or any other form of compensation, for services related to the Add-On.
    3. Addons may not include advertisements of any kind, including in-game requests for donations, unless expressly permitted by Trion.
    4. Add-Ons must not contain offensive or objectionable material, and must comply with the ESRB ‘T’ rating (and similar ratings from other ratings boards around the world) for RIFT.
    5. All Add-On code must be completely visible, not hidden or obfuscated in any way, and freely accessible to and viewable by the general public.
    6. Add-Ons may not negatively impact RIFT, its shards or other players, including, without limitation, excessive use of the chat system, unnecessary loading from the hard disk, or causing slow frame rates.
    7. Trion reserves the right to disable any Add-On or Add-On functionality at its sole discretion.
    If you have any questions about this User Interface Add-On Policy and/or how it pertains to any Add-On that you have developed, please email us at addons@RIFTgame.com.

  7.   This is the last Rift Team post in this thread.   #7
    Rift Team
    Join Date
    Oct 2010
    Posts
    927

    Default Standard RIFT Colors and Fonts

    Headers

    * Extra Large Heading: #FFFFFF, 25pt
    * Large Heading: #FCF6CB, 16pt
    * Medium Heading: #DBCE9B, 14pt
    * Small Heading: #FCF6CB, 12pt

    Text

    * Error (Neutral): #FFFFFF, 18pt
    * Normal Text: #FFFFFF, 15pt (Alternate colors #FCF8CB, #FF9730)
    * Descriptive Text: #FFFFFF, 13pt
    * Small Text, Search & Settings: #FFFFFF, 12pt

    Buttons

    * Normal: #DFD1A2
    * Over: #FFFFFF
    * Down: #F5F5F5
    * Disabled: #888888

    Item Rarity

    * Trash (gray): #888888
    * Common (white): #ffffff
    * Uncommon (green): #00cc00
    * Rare (dark blue): #2681fe
    * Epic (purple): #b049ff
    * Relic (orange): #ff9900
    * Transcendent (red): #cf1313
    * Eternal (aqua blue): #6bd3f7
    * Quest Item (yellow): #fff600
    * Ascended (pink): #ffaaff

    Factions

    * Neutral (gray): #bbbab4
    * Defiant (blue): #368dee
    * Guardian (purple): #806fe6

    Relations

    * Hostile (red): #f30000
    * Neutral (yellow): #fde72b
    * Friendly (green): #65e200

    Monster Difficulty

    * Impossible (red): #cf1313
    * Hard (orange): #de8e03
    * Medium (yellow): #d5c300
    * Easy (green): #51c412
    * Trivial (gray): #b4b4b4

    Stat Modifier

    * Stat Base (white): #ffffff
    * Stat Buffed (green): #65e200
    * Stat Debuffed (red): #f30000

    Calling

    * Warrior (red): #ff2828
    * Cleric (green): #77ef00
    * Mage (purple): #c85eff
    * Rogue (yellow): #ffdb00
    * Primalist (blue): #41d3fe

    Other

    * Item Set: #76f0e4
    * Bind on Account: #fff690
    * Cooldowns: #ffcb65
    Last edited by Gingers; 09-28-2016 at 03:03 PM. Reason: Added colors for primalist, transcendent, eternal and heirloom colors.

Closed Thread

Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts