Interface IConfig.IManagedInterface

Namespace

SampSharp.OpenMp.Core.Api

Assembly

SampSharp.OpenMp.Core.dll

Represents the managed interface implemented by its unmanaged counterpart.

public interface IConfig.IManagedInterface : IUnmanagedInterface

Inherited Members

IUnmanagedInterface.Handle

IUnmanagedInterface.HasValue

Methods

AddBan(BanEntry)

Adds a ban.

void AddBan(BanEntry entry)

Parameters

entry BanEntry

The ban entry to add.

ClearBans()

Clears all bans.

void ClearBans()

GetBan(Size)

Gets the ban at the specified index.

BanEntry? GetBan(Size index)

Parameters

index Size

The index of the ban.

Returns

BanEntry

The ban entry.

GetBansCount()

Gets the number of bans.

Size GetBansCount()

Returns

Size

The number of bans.

GetBool(string)

Get a variable as a boolean.

BlittableRef<bool> GetBool(string key)

Parameters

key string

The key of the variable.

Returns

BlittableRef<bool>

A pointer to the value.

GetFloat(string)

Get a variable as a float.

BlittableRef<float> GetFloat(string key)

Parameters

key string

The key of the variable.

Returns

BlittableRef<float>

A pointer to the value.

GetInt(string)

Get a variable as an integer.

BlittableRef<int> GetInt(string key)

Parameters

key string

The key of the variable.

Returns

BlittableRef<int>

A pointer to the value.

GetNameFromAlias(string)

Get an option name from an alias if available.

(bool, string?) GetNameFromAlias(string alias)

Parameters

alias string

The alias to find.

Returns

(bool, string)

A pair of bool which is true if the alias is deprecated and a string with the real config name.

GetOptions()

Gets all available options and their type.

IReadOnlyDictionary<string, ConfigOptionType> GetOptions()

Returns

IReadOnlyDictionary<string, ConfigOptionType>

GetString(string)

Get a variable as a string.

string? GetString(string key)

Parameters

key string

The key of the variable.

Returns

string

The value of the variable or null if not found.

GetStrings(string)

Gets a list of strings.

string?[] GetStrings(string key)

Parameters

key string

The key of the variable.

Returns

string[]

An array containing the string values.

GetValueType(string)

Gets the type of a variable.

ConfigOptionType GetValueType(string key)

Parameters

key string

The key of the variable.

Returns

ConfigOptionType

tHE type of the variable.

IsBanned(BanEntry)

Checks if a ban entry is banned.

bool IsBanned(BanEntry entry)

Parameters

entry BanEntry

The ban entry to check.

Returns

bool

true if the entry is banned; otherwise, false.

ReloadBans()

Reloads the bans.

void ReloadBans()

RemoveBan(BanEntry)

Removes a ban.

void RemoveBan(BanEntry entry)

Parameters

entry BanEntry

The ban entry to remove.

RemoveBan(Size)

Removes a ban.

void RemoveBan(Size index)

Parameters

index Size

The index of the ban to remove.

WriteBans()

Writes the bans to the file.

void WriteBans()