Metrognome-2.0

From WowAce Wiki
Jump to: navigation, search

API Documentation

Note: This documentation is auto-generated. Please note that direct modifications may be overwritten on next autogenerate.

:ChangeRate(name , newrate , n2 , r2 , n3 , r3 , n4 , r4 , n5 , r5)

Arguments

name
type - (needs documentation)
newrate
type - (needs documentation)
n2
type - (needs documentation)
r2
type - (needs documentation)
n3
type - (needs documentation)
r3
type - (needs documentation)
n4
type - (needs documentation)
r4
type - (needs documentation)
n5
type - (needs documentation)
r5
type - (needs documentation)


:ClearStats(name , n2 , n3 , n4 , n5 , n6 , n7 , n8 , n9 , n10)

Arguments

name
type - (needs documentation)
n2
type - (needs documentation)
n3
type - (needs documentation)
n4
type - (needs documentation)
n5
type - (needs documentation)
n6
type - (needs documentation)
n7
type - (needs documentation)
n8
type - (needs documentation)
n9
type - (needs documentation)
n10
type - (needs documentation)


:HasHandlers()

(No documentation)

:Profile(name)

Arguments

name
type - (needs documentation)

Returns

mem - the total memory consumed by the timer's execution (in KiB) time - the total time consumed by the timer's execution (in sec) count - the number of times the timer has been triggered rate - the rate at which the timer triggers (0 means the default OnUpdate rate)


:Register(name , func , rate , a1 , a2 , a3 , a4 , a5 , a6)

Arguments

name
type - (needs documentation)
func
type - (needs documentation)
rate
type - (needs documentation)
a1
type - (needs documentation)
a2
type - (needs documentation)
a3
type - (needs documentation)
a4
type - (needs documentation)
a5
type - (needs documentation)
a6
type - (needs documentation)


:RegisterMetro(name , func , rate , a1 , a2 , a3 , a4 , a5 , a6)

Arguments

name
type - (needs documentation)
func
type - (needs documentation)
rate
type - (needs documentation)
a1
type - (needs documentation)
a2
type - (needs documentation)
a3
type - (needs documentation)
a4
type - (needs documentation)
a5
type - (needs documentation)
a6
type - (needs documentation)


:Start(name , numexec)

Arguments

name
type - (needs documentation)
numexec
type - (needs documentation)


:Status(name)

Arguments

name
type - (needs documentation)

Returns

registered - true if a schedule exists with this name rate - the registered rate, if defined running - true if this schedule is currently running limit - limit of times to repeat this timer elapsed - time elapsed this cycle of the timer


:Stop(name)

Arguments

name
type - (needs documentation)


:Unregister(a1 , a2 , a3 , a4 , a5 , a6 , a7 , a8 , a9 , a10)

Arguments

a1
type - (needs documentation)
a2
type - (needs documentation)
a3
type - (needs documentation)
a4
type - (needs documentation)
a5
type - (needs documentation)
a6
type - (needs documentation)
a7
type - (needs documentation)
a8
type - (needs documentation)
a9
type - (needs documentation)
a10
type - (needs documentation)


:UnregisterMetro(a1 , a2 , a3 , a4 , a5 , a6 , a7 , a8 , a9 , a10)

Arguments

a1
type - (needs documentation)
a2
type - (needs documentation)
a3
type - (needs documentation)
a4
type - (needs documentation)
a5
type - (needs documentation)
a6
type - (needs documentation)
a7
type - (needs documentation)
a8
type - (needs documentation)
a9
type - (needs documentation)
a10
type - (needs documentation)


:activate(oldLib , oldDeactivate)

Arguments

oldLib
type - (needs documentation)
oldDeactivate
type - (needs documentation)