unreal

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 13, 2024 License: MIT Imports: 19 Imported by: 0

Documentation

Overview

Package unreal is the backend generation that takes care of generating gochart files for an Unreal project.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewUnrealGochartBackend

func NewUnrealGochartBackend(ctx context.Context, projectDir string) (*unrealGochartBackend, error)

func WithPlatform

func WithPlatform(platform unreal.UnrealPlatform) option.Option

func WithStrategy

func WithStrategy(strategy GenerationStrategy) option.Option

func WithTime

func WithTime(t time.Time) option.Option

func WithVersion

func WithVersion(version string) option.Option

Types

type GenerationStrategy

type GenerationStrategy int
const (
	// Intermediate means generating files into the project's intermediate files.
	GenerationStrategy_Intermediate GenerationStrategy = iota

	// Inline means generating the files right next to the gochart file.
	GenerationStrategy_Inline

	// ModuleGeneratedDir creates a Generated directory in the module root and append the internal
	// route to it.
	GenerationStrategy_ModuleGeneratedDir
)

func (GenerationStrategy) String

func (gs GenerationStrategy) String() string

type GochartOutput

type GochartOutput struct {
	Gochart *unreal.UnrealFile
	Outputs []*common.BackendOutput
}

func (*GochartOutput) UpToDate

func (o *GochartOutput) UpToDate() bool

type Options

type Options struct {
	Version string
	Time    time.Time

	Platform unreal.UnrealPlatform
	Strategy GenerationStrategy
}

TODO(cdc): Join options into a common backend options as well.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL