Funções

O BGForce oferece diversas funções de abstração de tarefas comuns na programação, desde obter listas de arquivos, salvamento e carregamento de dados, tradução, reprodução de sons, entre outros.

Caso deseje importar essas variáveis no seu próprio script (dado um script na raiz da pasta scripts, por exemplo: scripts/meuscript.py):

from .bgf import _
from .bgf import getFilePaths
from .bgf import isKeyPressed
from .bgf import playSound
from .bgf import saveFile

Referência

Abaixo estão listadas as funções disponíveis para uso no BGForce.

`bgf._(key)`

Retorna a tradução de key com base na linguagem atual definida em bgf.config["Lang"].

Parâmetros:

key (str) - Palavra chave da tradução

Retorna: str

`bgf.dump(obj, file="dump.py")`

Salva a representação em string de um objeto de Python em um arquivo. Útil para fins de depuração.

Parâmetros:

obj (object) - Objeto em Python, pode ser string, dict, list ou qualquer outro tipo
file (str) - Nome do arquivo onde salvará o conteúdo (opcional)

`bgf.getFilePaths(directory)`

Retorna um dicionário contendo todos os caminhos de arquivo de uma pasta no padrão {"Arquivo" : "Caminho/Para/Arquivo.txt"}. As chaves não possuem extensão do nome do arquivo.

Parâmetros:

directory (str) - Caminho da pasta

Retorna: dict

`bgf.getUpmostParent(obj)`

Retorna o objeto pai mais acima na hierarquia do objeto passado como parâmetro.

Parâmetros:

obj (KX_GameObject) - Objeto do jogo

Retorna: KX_GameObject

`bgf.isKeyPressed(key, status=bge.logic.KX_INPUT_ACTIVE)`

Retorna se uma tecla específica está sendo pressionada.

Parâmetros:

key (str ou int) - Nome ou código da tecla (ver constantes)
status (int) - Status de pressionamento da tecla (ver constantes)

Retorna: bool

`bgf.isWidgetHovered()`

Retorna se o mouse está por cima de algum widget clicável de interface de usuário.

Retorna: true

`bgf.loadFile(file)`

Carrega um arquivo file e retorna seu conteúdo como um dicionário. Suporta JSON, JSONC e JSON codificado com zlib.

Parâmetros:

directory (Path) - Caminho do arquivo

Retorna: dict

`bgf.loadFiles(directory, pattern="")`

Carrega todos os arquivos de directory e retorna seu conteúdo como um dicionário. Suporta JSON, JSONC e JSON codificado com zlib. Caso pattern seja passado, será usado como filtro de arquivos.

Parâmetros:

directory (Path) - Caminho do diretório
pattern (str) - Padrão glob para filtrar arquivos por nome (opcional)

Retorna: dict

`bgf.playSound(sound, origin=None)`

Executa um som de nome sound da pasta sounds/sfx (sem extensão). Caso um objeto origin seja fornecido, executará o som como 3D usando as coordenadas deste.

Parâmetros:

sound (str) - Nome do som
origin (KX_GameObject) - Objeto de referência para executar o som como 3D (opcional)

Retorna: Handle

`bgf.saveFile(file, data, ext=None)`

Salva no caminho de file os dados de data como JSON. Caso ext seja fornecida, usará esta como extensão de arquivo.

Parâmetros:

file (Path) - Caminho do arquivo a ser salvo
data (dict) - Dado a ser salvo
ext (str) - Extensão a ser usada no arquivo, suporta ".json", ".jsonc" e ".dat" (JSON codificado com zlib)

Retorna: dict