db

Documentation

Index

• func CharacterNameExists(characterName string) bool
• func Setup(ctx context.Context, dbName, dbUser, dbPassword string)
• func UserNameExists(userName string) bool
• type Connection
• type Room
  • func GetRooms() []Room
• type User
  • func CreateUser(userName, password, characterName string) *User
  • func Login(userName, password string) *User

Functions

func CharacterNameExists

func CharacterNameExists(characterName string) bool

CharacterNameExists checks to see if a character name exists

func Setup

func Setup(ctx context.Context, dbName, dbUser, dbPassword string)

Setup connects to database instance

func UserNameExists

func UserNameExists(userName string) bool

UserNameExists checks to see if a user name exists

Types

type Connection

type Connection struct {
	gorm.Model
	RoomID      uint
	NeighbourID uint
	Dir         core.Direction
	TwoWay      bool
}

Connection describes the connection between two rooms

type Room

type Room struct {
	gorm.Model
	Name        string
	Description string
	Connections []Connection
}

Room describes a room

func GetRooms

func GetRooms() []Room

GetRooms gets all rooms

type User

type User struct {
	gorm.Model
	UserName      string
	CharacterName string
	PasswordHash  string
}

User describes a logged on character

func CreateUser

func CreateUser(userName, password, characterName string) *User

CreateUser creates a new user

func Login

func Login(userName, password string) *User

Login returns a user if it exists