Farage API Overview - noglass/FarageBot GitHub Wiki

Introduction

This is still a big work in progress... Come back later.

Contents

basics.h

strlower

std::string strlower(std::string text);

mtrand

uint32_t mtrand(uint32_t lo = 0, uint32_t hi = -1);

recallGlobal

Farage::Global* Farage::recallGlobal(Farage::Global *global = nullptr);

findGlobVar

Farage::GlobVar* Farage::findGlobVar(const std::string &name);

consoleOut

void Farage::consoleOut(const std::string &msg);

errorOut

void Farage::errorOut(const std::string &msg);

debugOut

void Farage::debugOut(const std::string &msg);

verboseOut

void Farage::verboseOut(const std::string &msg);

saveAdminRoles

int Farage::saveAdminRoles();

ignoreChannel

int Farage::ignoreChannel(const std::string &ID, bool toggle = false);

ignoreUser

int Farage::ignoreUser(const std::string &ID, bool toggle = false);

saveIgnoredChannels

int Farage::saveIgnoredChannels();

saveIgnoredUsers

int Farage::saveIgnoredUsers();

admins.h

getAdminFlagBits

Farage::AdminFlag Farage::getAdminFlagBits(const std::string &flags);

getAdminFlagString

std::string Farage::getAdminFlagString(Farage::AdminFlag flagbits);

events.h

eventName

std::string Farage::eventName(Farage::Event event);

global.h

engineVersion

std::string Farage::Global::engineVersion();

getAdminFlags

Farage::AdminFlag Farage::Global::getAdminFlags(const std::string &userID);
Farage::AdminFlag Farage::Global::getAdminFlags(const std::string &guildID, const std::string &userID);

getAdminRoleFlags

Farage::AdminFlag Farage::Global::getAdminRoleFlags(const std::string &guildID, const std::string &roleID);

getBuffer

safe_ptr<std::vector<std::string>> Farage::Global::getBuffer();

tryGetBuffer

safe_ptr<std::vector<std::string>> Farage::Global::tryGetBuffer();

processTimersEarly

void Farage::Global::processTimersEarly();

globvar.h

getName

std::string Farage::GlobVar::getName();

getDesc

std::string Farage::GlobVar::getDesc();

getDefault

std::string Farage::GlobVar::getDefault();

reset

void Farage::GlobVar::reset(const std::string &guild = "");

getAsString

std::string Farage::GlobVar::getAsString(const std::string &guild = "");

getAsBool

bool Farage::GlobVar::getAsBool(const std::string &guild = "");

getAsInt

int Farage::GlobVar::getAsInt(const std::string &guild = "");

getAsFloat

float Farage::GlobVar::getAsFloat(const std::string &guild = "");

setString

void Farage::GlobVar::setString(const std::string &val, const std::string &guild = "");

setBool

void Farage::GlobVar::setBool(bool val, const std::string &guild = "");

setInt

void Farage::GlobVar::setInt(int val, const std::string &guild = "");

setFloat

void Farage::GlobVar::setFloat(float val, const std::string &guild = "");

hookChange

void Farage::GlobVar::hookChange(Farage::GlobVarHook func);

hooks.h

matches

bool Farage::ReactHook::matches(const std::string &userID, const std::string &channelID, const std::string &messageID, const std::string &guildID, const Farage::Emoji &reaction);

timers.h

remaining

template<class T> auto Farage::Timer::remaining();

remainingInterval

long Farage::Timer::remainingInterval();

trigger

int Farage::Timer::trigger(Handle &handle);

intervalString

std::string Farage::Timer::intervalString();
⚠️ **GitHub.com Fallback** ⚠️