Clan 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 Clan() Script Support Class function returns the Clan object.

Development

This function was added by Eric in version 2.7.

Documentation

'// CLAN
'// Returns the clan object
Public Function Clan() As Object

    Set Clan = g_Clan.Clone()

End Function

Syntax

To call a subroutine of the Clan object:

Clan().DoSomething

To store a value that the Clan object can retrieve:

Variable = Clan().GetSomething

Advanced Note: When the Clan function is called, a copy of the Clan object is made so that you cannot cause the bot to send bad information to Battle.net by changing properties of the internal clan object. Normally, the convention is to get values (like Clan.Name) from the bot's clan object, not from a clan object that you stored before using Set ClanObj = Clan(). This also guarantees that the information is more up to date.

See the Clan object article for examples and usage of the Clan object.

See also