You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
78 lines
2.7 KiB
78 lines
2.7 KiB
/** |
|
* API that allows easy access to `User` persistent data and `UserID`s. |
|
* Copyright 2020 Anton Tarasenko |
|
*------------------------------------------------------------------------------ |
|
* This file is part of Acedia. |
|
* |
|
* Acedia is free software: you can redistribute it and/or modify |
|
* it under the terms of the GNU General Public License as published by |
|
* the Free Software Foundation, version 3 of the License, or |
|
* (at your option) any later version. |
|
* |
|
* Acedia is distributed in the hope that it will be useful, |
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
* GNU General Public License for more details. |
|
* |
|
* You should have received a copy of the GNU General Public License |
|
* along with Acedia. If not, see <https://www.gnu.org/licenses/>. |
|
*/ |
|
class UserAPI extends AcediaObject; |
|
|
|
/** |
|
* Returns reference to the database of user records that Acedia was |
|
* set up to use. |
|
* |
|
* @return Main `UserDatabase` that Acedia currently uses to load and |
|
* store user information. Guaranteed to be a valid non-`none` reference. |
|
*/ |
|
public final function UserDatabase GetDatabase() |
|
{ |
|
return class'UserDatabase'.static.GetInstance(); |
|
} |
|
|
|
/** |
|
* Fetches `User` object that stores persistent data for a given `userID`. |
|
* |
|
* @param userID ID for which to fetch a persistent data storage. |
|
* @return `User` object for a given `UserID`. Guaranteed to be a valid |
|
* non-`none` reference if passed `userID` is not `none` and initialized |
|
* (which is guaranteed unless you manually created it). |
|
*/ |
|
public final function User Fetch(UserID userID) |
|
{ |
|
return class'UserDatabase'.static.GetInstance().FetchUser(userID); |
|
} |
|
|
|
/** |
|
* Fetches appropriate `User` object for a player, given his id as a `Text`. |
|
* |
|
* @param idHash `Text` representation of someone's id. |
|
* @return Corresponding `User` object. Guaranteed to be a valid non-`none` |
|
* reference. |
|
*/ |
|
public final function User FetchByIDHash(Text idHash) |
|
{ |
|
local UserID userID; |
|
local UserDatabase userDB; |
|
userDB = class'UserDatabase'.static.GetInstance(); |
|
userID = userDB.FetchUserID(idHash); |
|
return userDB.FetchUser(userID); |
|
} |
|
|
|
/** |
|
* Fetches appropriate `User` object for a player, given his session key. |
|
* |
|
* @param userKey Key corresponding to a `User` method must to get. |
|
* @return Corresponding `User` object. Guaranteed to be a valid non-`none` |
|
* reference if `userKey` was actually assigned to any `User` during |
|
* current playing session; `none` otherwise. |
|
*/ |
|
public final function User FetchByKey(int userKey) |
|
{ |
|
return class'UserDatabase'.static.GetInstance().FetchUserByKey(userKey); |
|
} |
|
|
|
defaultproperties |
|
{ |
|
} |