GetInternalDataByUsername function

From StealthBot Wiki Backup
Revision as of 08:20, 1 December 2017 by Davnit (talk | contribs) (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

The GetInternalDataByUsername function is provided by the Script Support Class to StealthBot to give additional information about users in the current channel.

Development

The GetInternalDataByUsername function was added in version 2.5.

Syntax

GetInternalDataByUsername(sUser, lDataType) 

Arguments

  • sUser is the name of the user in the current channel.
  • lDataType is the type of information you want.
 Possible lDataType values.
 0 '// GID_CLAN          -> retrieves 4-character clan name
 1 '// GID_FLAGS         -> retrieves Battle.net flags
 2 '// GID_PING          -> retrieves ping on login
 3 '// GID_PRODUCT       -> retrieves 4-digit product code
 4 '// GID_ISSAFELISTED  -> retrieves Boolean value denoting safelistedness
 5 '// GID_STATSTRING    -> retrieves unparsed statstring
 6 '// GID_TIMEINCHANNEL -> retrieves time in channel in seconds
 7 '// GID_TIMESINCETALK -> retrieves time since last message in seconds

Examples

  • Get a users clan tag.
  • ClanTag = GetInternalDataByUsername(Username, 0)
    
  • Get a users ping value.
  • Ping = GetInternalDataByUsername(Username, 2)
    

See also