LogoPixi’VN

Storage

How to store, retrieve, and manage persistent and temporary variables in Pixi’VN, including Keyv integration.

It is essential to understand that if variables are not saved in the game memory, the engine will not be able to handle them when you load a save or when you go back.

Additionally, in the game archive you can save any type of variable, except class and function (because they cannot be converted to JSON), such as: string, number, boolean, object, array, etc. If you want to save "flags" (boolean), it is recommended to use the flags functionality, a very high-performance flag management system.

ink

You can use this method with the ink syntax. See more here.

Set

To set a variable in the game storage, use storage.set.

import { storage } from "@drincs/pixi-vn";

storage.set("myVariable", 42);

Get

To get a variable from the game storage, use storage.get.

import { storage } from "@drincs/pixi-vn";

const myVariable = storage.get("myVariable");

Remove

To remove a variable from the game storage, use storage.remove.

import { storage } from "@drincs/pixi-vn";

storage.remove("myVariable");

Other features

On this page