Difference between revisions of "Flurry.logEvent"
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | + | '''Available since:''' Gideros 2011.6<br/> | |
| − | ''' | + | '''Class:''' [[Flurry]]<br/> |
| − | ''' | + | |
| − | === | + | === Description === |
| − | + | Use this function to count the number of times certain events happen during a session of your application and to pass dynamic parameters to be recorded with that event. | |
| − | to be recorded with that event. Event parameters is optional and can be passed in as a table value. Your application is currently limited to counting | + | <syntaxhighlight lang="lua"> |
| − | occurrences for 100 different event ids (maximum length 255 characters). Maximum of 10 event parameters per event is supported. | + | flurry.logEvent(eventName,parameters,timed) |
| − | + | </syntaxhighlight> | |
| − | To start a timed event, pass ''timed'' parameter as ''true''. | + | |
| − | + | Event ''parameters'' is optional and can be passed in as a table value. Your application is currently limited to counting occurrences for 100 different event ids (maximum length 255 characters). Maximum of 10 event parameters per event is supported. | |
| − | + | ||
| − | + | To start a timed event, pass ''timed'' parameter as ''true''. | |
| − | + | ||
| − | == | + | === Parameters === |
| − | '''eventName''': (string) | + | '''eventName''': (string) the event name to be logged at Flurry service<br/> |
| − | '''parameters''': (table, optional) | + | '''parameters''': (table, optional) optional parameters to be recorded with this event<br/> |
| − | '''timed''': (boolean, optional) | + | '''timed''': (boolean, optional) specifies this is a timed event<br/> |
| − | === | + | |
| − | + | === Examples === | |
| − | + | <syntaxhighlight lang="lua"> | |
| − | flurry.logEvent( | + | flurry.logEvent("myEvent1") |
| − | flurry.logEvent( | + | flurry.logEvent("myEvent2", { key="value" } ) |
| + | flurry.logEvent("myEvent3", { key="value" }, true) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | '''You can log events in key parts of your game''' | ||
| + | <syntaxhighlight lang="lua"> | ||
| + | local function Level1() | ||
| + | flurry.logEvent("Level1") | ||
| + | --flurry.logEvent( "Level1", { difficulty="Easy", lives=3 } ) | ||
| + | |||
| + | --Level1 code... | ||
| + | end | ||
| + | |||
| + | Level1() | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | {{Flurry}} | ||
Latest revision as of 22:27, 7 December 2023
Available since: Gideros 2011.6
Class: Flurry
Description
Use this function to count the number of times certain events happen during a session of your application and to pass dynamic parameters to be recorded with that event.
flurry.logEvent(eventName,parameters,timed)
Event parameters is optional and can be passed in as a table value. Your application is currently limited to counting occurrences for 100 different event ids (maximum length 255 characters). Maximum of 10 event parameters per event is supported.
To start a timed event, pass timed parameter as true.
Parameters
eventName: (string) the event name to be logged at Flurry service
parameters: (table, optional) optional parameters to be recorded with this event
timed: (boolean, optional) specifies this is a timed event
Examples
flurry.logEvent("myEvent1")
flurry.logEvent("myEvent2", { key="value" } )
flurry.logEvent("myEvent3", { key="value" }, true)
You can log events in key parts of your game
local function Level1()
flurry.logEvent("Level1")
--flurry.logEvent( "Level1", { difficulty="Easy", lives=3 } )
--Level1 code...
end
Level1()