bz eGetPlayerMotto

From BZFlagWiki
Revision as of 21:54, 28 February 2013 by Allejo (Talk | contribs) (added V2 info)

Jump to: navigation, search
BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server.

BZFS Event. This page documents a BZFS event that is called by the game server to notify plug-ins of various actions and state changes in the game world.


Overview

The bz_eGetPlayerMotto is an API event that is called when the player joins. It gives us the motto of the player.

Data

bz_eGetPlayerMotto returns the bz_GetPlayerMottoData_V2 data class.

name type value description
eventType bz_eEventType bz_eGetPlayerMotto
motto bz_ApiString The motto of the joining player.
record bz_BasePlayerRecord The player record for the player using the motto.
eventTime double The server time the event occurred (in seconds.)

Uses

This event is called before the ePlayerJoinEvent. So what you can do is store the motto in a string, and later check it when you get the other player data. As of 2.4.0, this is the only method of getting the motto.