Skip to content

Return of Reckoning

Wiki

RoR Wiki

API:SendBannerConfigurationData

From RoR Wiki

UI Lua API · Guild functions
Version: WAR 1.4.8

Sends the tactics and post of one guild standard to the server.

SendBannerConfigurationData(bannerNumber, numSlots, ability1, ability2, ability3, postNumber)

Arguments

bannerNumber
number – Standard number. Sent as an 8-bit value.
numSlots
number – Number of ability slots. The client does not use this value.
ability1, ability2, ability3
number – Ability ids for the three tactic slots (0 for an empty slot). Sent as 32-bit values.
postNumber
number – Banner post. Sent as an 8-bit value.

Returns

Nothing.

Details

  • numSlots must be a number but is ignored; always three ability ids are sent. The stock UI passes 3.
  • The client does not check permissions. The stock UI hides the Save button for players without the SystemData.GuildPermissons.BANNER_MANAGEMENT permission.
  • If there is no player object, or the Lua state is not available, nothing is sent.
  • The function needs at least six arguments and only reads the last six.

Errors

None besides the generic Invalid Parameters message when an argument is not a number.

Example

From default/ea_guildwindow/source/guildwindowtabbanner.lua:

-- Params are : Banner Number, Number of ability slots for this banner. (Should be 3), Ability1ID, Ability2ID, Ability3ID, PostID
-- NOTE: No Trophy support at this time.
SendBannerConfigurationData( GuildWindowTabBanner.CurrentBannerNumber,
                             3,
                             GuildWindowTabBanner.Banners[GuildWindowTabBanner.CurrentBannerNumber].AbilityID[1],
                             GuildWindowTabBanner.Banners[GuildWindowTabBanner.CurrentBannerNumber].AbilityID[2],
                             GuildWindowTabBanner.Banners[GuildWindowTabBanner.CurrentBannerNumber].AbilityID[3],
                             GuildWindowTabBanner.CurrentPostNumber)
BroadcastEvent( SystemData.Events.UPDATE_GUILDSTANDARD )

See also