1
0
mirror of synced 2024-12-04 19:17:58 +01:00

Merge pull request #11 from damon-murdoch/master

Car Ordering, Terminal Scratch, Item Accepting, Discarded Cards, and more :)
This commit is contained in:
Luna 2022-07-22 17:59:30 +01:00 committed by GitHub
commit b200569118
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 1123 additions and 534 deletions

View File

@ -4,8 +4,9 @@
"regionName": "Bayshore",
"serverIp": "127.0.0.1",
"gameOptions": {
"grantFullTuneTicketToNewUsers": 0,
"grantAllScratchRewards": 0,
"grantBonusScratchCars": 0
"grantFullTuneTicketToNewUsers": 3,
"giftCarsFullyTuned": 0,
"scratchEnabled": 1,
"scratchType": 1
}
}

View File

@ -2,184 +2,186 @@
// learn more about it in the docs: https://pris.ly/d/prisma-schema
generator client {
provider = "prisma-client-js"
provider = "prisma-client-js"
}
datasource db {
provider = "postgresql"
url = env("POSTGRES_URL")
provider = "postgresql"
url = env("POSTGRES_URL")
}
model User {
id Int @id @default(autoincrement())
chipId String @unique
accessCode String
cars Car[]
carOrder Int[] // Order of cars
unusedTickets UserItem[]
tutorials Boolean[]
userBanned Boolean @default(false)
bookmarks Int[]
// ScratchSheet ScratchSheet[]
currentSheet Int @default(0)
lastSheet Int @default(0)
id Int @id @default(autoincrement())
chipId String @unique
accessCode String
cars Car[]
carOrder Int[]
items UserItem[]
tutorials Boolean[]
userBanned Boolean @default(false)
bookmarks Int[]
ScratchSheet ScratchSheet[]
currentSheet Int @default(1)
lastScratched Int @default(0) // Timestamp
}
// Not working yet, removing from schema
// model ScratchSheet {
// id Int @id @default(autoincrement())
// User User @relation(fields: [userId], references: [id])
// userId Int @unique
// squares ScratchSquare[]
// }
model ScratchSheet {
id Int @id @default(autoincrement())
User User @relation(fields: [userId], references: [id])
userId Int
sheetNo Int // Player's sheet number (i.e. first sheet)
squares ScratchSquare[]
}
// model ScratchSquare {
// id Int @id @default(autoincrement())
// Sheet ScratchSheet @relation(fields: [sheetId], references: [id])
// sheetId Int
// category Int
// itemId Int
// earned Boolean
// }
model ScratchSquare {
id Int @id @default(autoincrement())
Sheet ScratchSheet @relation(fields: [sheetId], references: [id])
sheetId Int
category Int
itemId Int
earned Boolean
}
model UserItem {
dbId Int @id @default(autoincrement())
category Int
itemId Int
User User @relation(fields: [userId], references: [id])
userId Int
userItemId Int @id @default(autoincrement())
category Int
itemId Int
User User @relation(fields: [userId], references: [id])
userId Int
type Int @default(0)
earnedAt Int @default(0)
}
model Car {
user User @relation(fields: [userId], references: [id])
userId Int
user User @relation(fields: [userId], references: [id])
userId Int
// This is the Car object itself
carId Int @id @default(autoincrement())
name String
manufacturer Int
regionId Int @default(0)
model Int
visualModel Int
customColor Int @default(0)
defaultColor Int
wheel Int @default(0)
wheelColor Int @default(0)
aero Int @default(0)
bonnet Int @default(0)
wing Int @default(0)
mirror Int @default(0)
neon Int @default(0)
trunk Int @default(0)
plate Int @default(0)
plateColor Int @default(0)
plateNumber Int @default(0)
tunePower Int @default(0)
tuneHandling Int @default(0)
title String @default("New Car")
level Int @default(0)
windowSticker Boolean @default(false)
windowStickerString String @default("")
windowStickerFont Int @default(0)
rivalMarker Int @default(0)
aura Int @default(0)
auraMotif Int @default(0)
ghostLevel Int @default(1)
// This is the Car object itself
carId Int @id @default(autoincrement())
name String
manufacturer Int
regionId Int @default(0)
model Int
visualModel Int
customColor Int @default(0)
defaultColor Int
wheel Int @default(0)
wheelColor Int @default(0)
aero Int @default(0)
bonnet Int @default(0)
wing Int @default(0)
mirror Int @default(0)
neon Int @default(0)
trunk Int @default(0)
plate Int @default(0)
plateColor Int @default(0)
plateNumber Int @default(0)
tunePower Int @default(0)
tuneHandling Int @default(0)
title String @default("New Car")
level Int @default(0)
windowSticker Boolean @default(false)
windowStickerString String @default("")
windowStickerFont Int @default(0)
rivalMarker Int @default(0)
lastPlayedAt Int @default(0)
aura Int @default(0)
auraMotif Int @default(0)
ghostLevel Int @default(1)
// This is more data about the car
tuningPoints Int @default(0)
odometer Int @default(0)
playCount Int @default(0)
earnedCustomColor Boolean @default(false)
carSettingsDbId Int @unique
settings CarSettings @relation(fields: [carSettingsDbId], references: [dbId])
vsPlayCount Int @default(0)
vsBurstCount Int @default(0)
vsStarCount Int @default(0)
vsCoolOrWild Int @default(0)
vsSmoothOrRough Int @default(0)
vsTripleStarMedals Int @default(0)
vsDoubleStarMedals Int @default(0)
vsSingleStarMedals Int @default(0)
vsPlainMedals Int @default(0)
rgPlayCount Int @default(0)
rgWinCount Int @default(0)
rgTrophy Int @default(0)
rgScore Int @default(0)
rgStamp Int @default(0)
rgAcquireAllCrowns Boolean @default(false)
rgRegionMapScore Int[]
dressupLevel Int @default(0)
dressupPoint Int @default(0)
stPlayCount Int @default(0)
stClearBits Int @default(0)
stClearDivCount Int @default(0)
stClearCount Int @default(0)
stLoseBits BigInt @default(0)
stConsecutiveWins Int @default(0)
stConsecutiveWinsMax Int @default(0)
stCompleted100Episodes Boolean @default(false)
// This is more data about the car
tuningPoints Int @default(0)
odometer Int @default(0)
playCount Int @default(0)
earnedCustomColor Boolean @default(false)
carSettingsDbId Int @unique
settings CarSettings @relation(fields: [carSettingsDbId], references: [dbId])
vsPlayCount Int @default(0)
vsBurstCount Int @default(0)
vsStarCount Int @default(0)
vsCoolOrWild Int @default(0)
vsSmoothOrRough Int @default(0)
vsTripleStarMedals Int @default(0)
vsDoubleStarMedals Int @default(0)
vsSingleStarMedals Int @default(0)
vsPlainMedals Int @default(0)
rgPlayCount Int @default(0)
rgWinCount Int @default(0)
rgTrophy Int @default(0)
rgScore Int @default(0)
rgStamp Int @default(0)
rgAcquireAllCrowns Boolean @default(false)
rgRegionMapScore Int[]
dressupLevel Int @default(0)
dressupPoint Int @default(0)
stPlayCount Int @default(0)
stClearBits Int @default(0)
stClearDivCount Int @default(0)
stClearCount Int @default(0)
stLoseBits BigInt @default(0)
stConsecutiveWins Int @default(0)
stConsecutiveWinsMax Int @default(0)
stCompleted100Episodes Boolean @default(false)
items CarItem[]
items CarItem[]
carStateDbId Int @unique
state CarState @relation(fields: [carStateDbId], references: [dbId])
TimeAttackRecord TimeAttackRecord[]
carStateDbId Int @unique
state CarState @relation(fields: [carStateDbId], references: [dbId])
TimeAttackRecord TimeAttackRecord[]
}
model CarItem {
dbId Int @id @default(autoincrement())
Car Car @relation(fields: [carId], references: [carId])
carId Int
category Int
itemId Int
amount Int
dbId Int @id @default(autoincrement())
Car Car @relation(fields: [carId], references: [carId])
carId Int
category Int
itemId Int
amount Int
}
model CarSettings {
dbId Int @id @default(autoincrement())
car Car?
dbId Int @id @default(autoincrement())
car Car?
view Boolean @default(true)
transmission Boolean @default(false)
retire Boolean @default(false)
meter Int @default(0)
navigationMap Boolean @default(true)
volume Int @default(1)
bgm Int @default(0)
nameplate Int @default(0)
nameplateColor Int @default(0)
terminalBackground Int @default(0)
view Boolean @default(true)
transmission Boolean @default(false)
retire Boolean @default(false)
meter Int @default(0)
navigationMap Boolean @default(true)
volume Int @default(1)
bgm Int @default(0)
nameplate Int @default(0)
nameplateColor Int @default(0)
terminalBackground Int @default(0)
}
model CarState {
dbId Int @id @default(autoincrement())
car Car?
dbId Int @id @default(autoincrement())
car Car?
hasOpponentGhost Boolean @default(false)
eventJoined Boolean @default(false)
transferred Boolean @default(false)
toBeDeleted Boolean @default(false)
hasOpponentGhost Boolean @default(false)
eventJoined Boolean @default(false)
transferred Boolean @default(false)
toBeDeleted Boolean @default(false)
}
model TimeAttackRecord {
dbId Int @id @default(autoincrement())
dbId Int @id @default(autoincrement())
car Car @relation(fields: [carId], references: [carId])
carId Int
car Car @relation(fields: [carId], references: [carId])
carId Int
model Int // Car model, literally just the `model` field from Car
time Int
course Int
isMorning Boolean
section1Time Int @map("section1Time")
section2Time Int @map("section2Time")
section3Time Int @map("section3Time")
section4Time Int @map("section4Time")
section5Time Int? @map("section5Time")
section6Time Int? @map("section6Time")
section7Time Int? @map("section7Time")
tunePower Int @default(0) // Car Power
tuneHandling Int @default(0) // Car Handling
model Int // Car model, literally just the `model` field from Car
time Int
course Int
isMorning Boolean
section1Time Int @map("section1Time")
section2Time Int @map("section2Time")
section3Time Int @map("section3Time")
section4Time Int @map("section4Time")
section5Time Int? @map("section5Time")
section6Time Int? @map("section6Time")
section7Time Int? @map("section7Time")
tunePower Int @default(0) // Car Power
tuneHandling Int @default(0) // Car Handling
}

View File

@ -17,16 +17,28 @@ export interface UnixOptions {
}
export interface GameOptions {
// If set to 1, all scratch rewards will be granted to players (including cars)
grantAllScratchRewards: number;
// If set to 1, gives the player a random colour for each of the special cars.
// If set to 2, allows the player to pick any of the colours (more cluttered)
grantBonusScratchCars: number;
// If set to 1, all gift cars (i.e. S2000, S660, etc. will be fully tuned.)
// If set to 0, they will be left at their default tune (i.e. stock, basic tune, etc.)
giftCarsFullyTuned: number,
giftCarsFullyTuned: number;
// If set to 1, the scratch game will be enabled and the player
// will be allowed to scratch boxes once every day. If this is
// set to 0, the scratch sheet will always be unavailable,
// however previously recieved items (or items provided by
// grantAllScratchRewards) will still be available. If the
// value is set to 2, there will be no limits on the number
// of times the player can scratch daily.
scratchEnabled: number;
// If set to 0, the standard scratch sheets (Same as the actual game)
// will be available in order, e.g. R2, Corolla, and so on.
// If it is set to 1, random scratch sheets will be generated
// (with 1 scratch car, 25 window stickers, and 24 versus markers infinitely.)
// OPTION 1 IS IN PROGRESS! PLEASE USE OPTION 2 FOR NOW!
scratchType: number;
// Amount of full-tunes to grant to newly registered cards
grantFullTuneTicketToNewUsers: number;

File diff suppressed because it is too large Load Diff

405
src/util/scratch.ts Normal file
View File

@ -0,0 +1,405 @@
import { isRateLimited } from "@sentry/utils";
import { prisma } from "..";
import { Config } from "../config";
import * as wm from "../wmmt/wm.proto";
// *** CONSTANTS ***
// Scratch Sheets
let scratchSheets = [
[ // Sheet 1
[201, 4], // R2
// Window Stickers
[25, 8], [25, 8], [25, 8], [25, 8], [25, 8], // BAT
[25, 6], [25, 6], [25, 6], [25, 6], [25, 6], // SPEAR
[25, 24], [25, 24], [25, 24], [25, 24], [25, 24], // PULSE
[25, 3], [25, 3], [25, 3], [25, 3], [25, 3], // CIRCLE
[25, 14], [25, 14], [25, 14], [25, 14], [25, 14], // TRIBAL
// Rival Markers
[26, 18], [26, 18], [26, 18], [26, 18], // LIGHTNING
[26, 2], [26, 2], [26, 2], [26, 2], // NEON
[26, 31], [26, 31], [26, 31], [26, 31], // V
[26, 40], [26, 40], [26, 40], [26, 40], // NEW DRIVER
[26, 1], [26, 1], [26, 1], [26, 1], // FIRE
[26, 17], [26, 17], [26, 17], [26, 17], // TROPICAL
],
[ // Sheet 2
[201, 3], // Corolla
// Window Stickers
[25, 11], [25, 11], [25, 11], [25, 11], [25, 11], // Thunderbolt
[25, 4], [25, 4], [25, 4], [25, 4], [25, 4], // Circle 2
[25, 28], [25, 28], [25, 28], [25, 28], [25, 28], // Wangan URL
[25, 5], [25, 5], [25, 5], [25, 5], [25, 5], // Triangle
[25, 16], [25, 16], [25, 16], [25, 16], [25, 16], // Cards
// Rival Markers
[26, 9], [26, 9], [26, 9], [26, 9], // GRAFFITI
[26, 6], [26, 6], [26, 6], [26, 6], // CASUAL
[26, 19], [26, 19], [26, 19], [26, 19], // WALL
[26, 29], [26, 29], [26, 29], [26, 29], // BAT
[26, 2], [26, 2], [26, 2], [26, 2], // ANIMAL
[26, 8], [26, 8], [26, 8], [26, 8], // PAINT SPLASH
]
/*
[ // Sheet 3 (Incomplete)
[201, 1], // Hiace Van
// Window Stickers
[25, 13], [25, 13], [25, 13], [25, 13], [25, 13], // Arrow
[25, 9], [25, 9], [25, 9], [25, 9], // Star
[25, 7], [25, 7], [25, 7], [25, 7], // Snake
[25, 18], [25, 18], [25, 18], [25, 18], // Heart
[25, ], [25, ], [25, ], [25, ], // ????
// Rival Markers
[26, 36], [26, 36], [26, 36], [26, 36], // Pinstripe
[26, 5], [26, 5], [26, 5], [26, 5], // Dangerous
[26, 14], [26, 14], [26, 14], [26, 14], // Relief
[26, 34], [26, 34], [26, 34], [26, 34], // Diamond
[26, 4], [26, 4], [26, 4], [26, 4], // Metal
[26, 10], [26, 10], [26, 10], [26, 10], // Japonism
[26, 20], [26, 20], [26, 20], [26, 20], // Reggae
],
[ // Sheet 4 (Incomplete)
[201, 2], // Pajero Evolution
// Window Stickers
[25, 21], [25, 21], [25, 21], [25, 21], [25, 21], // Plum Blossoms
[25, 12], [25, 12], [25, 12], [25, 12], // Illumination
[25, 10], [25, 10], [25, 10], [25, 10], // Shooting Star
[25, 20], [25, 20], [25, 20], [25, 20], // Raimo
[25, ], [25, ], [25, ], [25, ], // ????
// Rival Markers
[26, 7], [26, 7], [26, 7], [26, 7], // Flowers
[26, 16], [26, 16], [26, 16], [26, 16], // Wood
[26, 24], [26, 24], [26, 24], [26, 24], // Studded
[26, 33], [26, 33], [26, 33], [26, 33], // Heart
[26, 15], [26, 15], [26, 15], [26, 15], // Camo
[26, 21], [26, 21], [26, 21], [26, 21], // Decoration
[26, 30], [26, 30], [26, 30], [26, 30], // Effect
],
[ // Sheet 5 (Incomplete)
[201, 5], // Nismo GT-R (Black)
// Window Stickers
[25, 26], [25, 26], [25, 26], [25, 26], [25, 26], // Paint
[25, 29], [25, 29], [25, 29], [25, 29], // Galaga
[25, 23], [25, 23], [25, 23], [25, 23], // Maze
[25, 2], [25, 2], [25, 2], [25, 2], // Fire Pattern 2
[25, ], [25, ], [25, ], [25, ], // ????
// Rival Markers
[26, 39], [26, 39], [26, 39], [26, 39], // Silver Accessory
[26, 22], [26, 22], [26, 22], [26, 22], // Tropical 2
[26, 25], [26, 25], [26, 25], [26, 25], // Casual 2
[26, 28], [26, 28], [26, 28], [26, 28], // Guitar Pick
[26, 12], [26, 12], [26, 12], [26, 12], // Mechanical
[26, 23], [26, 23], [26, 23], [26, 23], // Monogram
[26, 27], [26, 27], [26, 27], [26, 27], // Carbon
],
[ // Sheet 6 (Incomplete)
[201, 6], // Fairlady Z (Nismo)
// Window Stickers
[25, 25], [25, 25], [25, 25], [25, 25], [25, 25], // Equaliser
[25, 17], [25, 17], [25, 17], [25, 17], // Cards 2
[25, 30], [25, 30], [25, 30], [25, 30], // Pac-Man
[25, 22], [25, 22], [25, 22], [25, 22], // Seigaiha
[25, ], [25, ], [25, ], [25, ], // ????
// Rival Markers
[26, 38], [26, 38], [26, 38], [26, 38], // Hex
[26, 13], [26, 13], [26, 13], [26, 13], // Cosmos
[26, 35], [26, 35], [26, 35], [26, 35], // Fire Pattern
[26, 32], [26, 32], [26, 32], [26, 32], // Feather
[26, 11], [26, 11], [26, 11], [26, 11], // Silvercraft
[26, 26], [26, 26], [26, 26], [26, 26], // Graffiti 2
[26, 37], [26, 37], [26, 37], [26, 37], // Arrow of Light
],
[ // Sheet 7 (Incomplete)
[201, 16], // Aristo (Taxi)
// Window Stickers
[25, 32], [25, 32], [25, 32], [25, 32], [25, 32], // Emotion
[25, 17], [25, 17], [25, 17], [25, 17], // Pine
[25, 30], [25, 30], [25, 30], [25, 30], // Love
// [25, 22], [25, 22], [25, 22], [25, 22], // Square
[25, 35], [25, 35], [25, 35], [25, 35], [25, 35], // Trap
// Rival Markers
[26, 38], [26, 38], [26, 38], [26, 38], // Shuriken
[26, 13], [26, 13], [26, 13], [26, 13], // Electronics
[26, 35], [26, 35], [26, 35], [26, 35], // Paint Splash 2
[26, 32], [26, 32], [26, 32], [26, 32], // Katana
[26, 11], [26, 11], [26, 11], [26, 11], // Steel
[26, 26], [26, 26], [26, 26], [26, 26], // Wall 2
],
*/
]
// Terminal scratch cars only
export const scratchCars = [
4, 3, 1, 2, 5, 6, 16, 17, 18, 19, 20, 21
]
// Fully tuned special cars
export const fullyTunedCars = [
4, 3, 1, 2, 5, 6, 16, 17, 18, 19, 20, 21, 39
];
// Basic tuned special cars
export const basicTunedCars = [
38
];
// Stock tuned special cars
export const stockTunedCars = [
7, 8, 9, 10, 11, 12, 13, 14, 15,
22, 23, 24, 25, 26, 27, 37, 28,
29, 30, 31, 32, 33, 34, 35, 36
];
// *** FUNCTIONS ***
// Get a random integer within a range
function getRandom(a: number, b: number)
{
// Return a random integer within the range
return Math.floor(Math.random() * (b - a)) + a;
}
// Get the days since epoch
function daysSinceEpoch(date: Date)
{
// Return the days since the epoch
return Math.floor(Number(date)/8.64e7);
};
// Fisher yates shuffle for the scratch card elements
function shuffleScratchSheet (array: number[][])
{
// Loop over all of the array elements
for (let i = array.length - 1; i > 0; i--)
{
// Randomly swap items in the array
const j = Math.floor(Math.random() * (i + 1));
const temp = array[i];
array[i] = array[j];
array[j] = temp;
}
// Return the sorted array
return array;
}
// Generates a random scratch sheet
// Contents:
// 1 Random Scratch Car
// 25 Random Scratch Stickers
// 24 Random Scratch Versus Markers
function getRandomScratchSheet (carId: number)
{
// Scratch items list
let items : number[][] = [];
// Add the scratch car for the given index
items.push([201, scratchCars[carId % scratchCars.length]]);
// Add the random scratch stickers
// Five different sticker styles
for(let i=0; i<5; i++)
{
// Get a random versus marker
let sticker = getRandom(0, 60);
// Five different instances
for(let j=0; j<5; j++)
{
// Add marker to the list
items.push([25, sticker + 1])
}
}
// Add the random versus markers
// Six different marker styles
for(let i=0; i<6; i++)
{
// Get a random versus marker
let marker = getRandom(0, 80);
// Four different instances
for(let j=0; j<4; j++)
{
// Add marker to the list
items.push([26, marker + 1])
}
}
// Return the items list
return items;
}
// Get the days passed between dates 'a' and 'b'
export function dayPassed(a: Date, b: Date)
{
// Return 1 if a day has passed since the last scratch, 0 otherwise
return daysSinceEpoch(a) > daysSinceEpoch(b) ? 0 : 1;
}
// Async function for generating a new scratch sheet
export async function generateScratchSheet (userId: number, sheetNo: number)
{
// Scratch items list
let scratchItems : number[][] = [];
// Get the scratch sheet type
let scratchType = Config.getConfig().gameOptions.scratchType;
// Switch on the scratch sheet type in the config
switch(scratchType)
{
// More options maybe added in the future
case 0: // Same as actual game (randomised after last set)
// If the sheet number has associated data
if (scratchSheets.length >= sheetNo)
{
// Get the data for the requested sheet
scratchItems = scratchSheets[sheetNo-1];
}
else // Sheet is out of range
{
// Generate a random (standard) scratch sheet
scratchItems = getRandomScratchSheet(sheetNo-1);
}
break;
case 1: // Infinite random scratch sheets (Standard Items)
// Generate a random (standard) scratch sheet
scratchItems = getRandomScratchSheet(sheetNo-1);
break;
default: // Not implemented
console.log("Method not implemented: " + scratchType);
break;
}
// If there is at LEAST one scratch item
if (scratchItems.length > 0)
{
// Create a new scratch sheet for the user
let sheet = await prisma.scratchSheet.create({
data: {
userId: userId,
sheetNo: sheetNo
}
});
// Shuffle the scratch items list
scratchItems = shuffleScratchSheet(scratchItems);
// Populate the scratch sheet with the items
for (let item of scratchItems) {
await prisma.scratchSquare.create({
data: {
sheetId: sheet.id,
category: item[0],
itemId: item[1],
earned: false
}
});
}
}
else // No scratch items
{
console.log("No scratch items. Sheet not created");
}
}
export async function getScratchItemList (userId: number, date: number)
{
// Owned user items list
let ownedUserItems : wm.wm.protobuf.UserItem[] = [];
// Get all of the user's scratch items from the database
let scratchUserItems = await prisma.userItem.findMany({
where: {
userId: userId,
type: 1 // Scratch Item
}
});
// Loop over all of the returned items
for(let item of scratchUserItems)
{
// Add all of the scratch items to the list
ownedUserItems.push(wm.wm.protobuf.UserItem.create({
category: item.category,
itemId: item.itemId,
userItemId: item.userItemId,
earnedAt: item.earnedAt
// no expiration date
}));
}
// Return the owned user items list
return ownedUserItems;
}
export async function getScratchSheetProto (userId: number)
{
// Scratch sheet proto
let scratchSheetProto : wm.wm.protobuf.ScratchSheet[] = [];
// Get all of the scratch sheets for the user
let scratchSheets = await prisma.scratchSheet.findMany({
where: {
userId: userId
},
include: {
squares: {
orderBy: {
id: 'asc'
}
}
}
});
// Loop over all of the protos
for(let sheet of scratchSheets)
{
// Get all of the scratch squares
let scratchSquareProto : wm.wm.protobuf.ScratchSheet.ScratchSquare[] = [];
// Loop over all of the squares
for (let square of sheet.squares)
{
// Add the current square to the protobuf array
scratchSquareProto.push(wm.wm.protobuf.ScratchSheet.ScratchSquare.create({
category: square.category,
itemId: square.itemId,
earned: square.earned
}));
}
// Add the scratch sheet to the sheets list
scratchSheetProto.push(
wm.wm.protobuf.ScratchSheet.create({
squares: scratchSquareProto
})
);
}
// Return the scratch sheet proto object
return scratchSheetProto;
}