platform

Documentation

Index

• type BaseTargetWithoutFeature
• type BaseTemplateWithoutFeature
• type Exporter
• type TargetBuilder
• type TargetPlatforms
• type Targets
  • func (t Targets) Combine(rc *run.Context) (Exporter, error)
• type TemplateBuilder
• type TemplatePlatforms
• type Templater
• type Templates
  • func (t *Templates) Combine(rc *run.Context) (Templater, error)

Types

type BaseTargetWithoutFeature

type BaseTargetWithoutFeature struct {
	*common.Target

	Profile map[engine.Profile]common.Target `toml:"profile"`
}

type BaseTemplateWithoutFeature

type BaseTemplateWithoutFeature struct {
	*common.Template

	Profile map[engine.Profile]common.Template `toml:"profile"`
}

type Exporter

type Exporter interface {
	config.Configurable[*run.Context]

	Collect(rc *run.Context, tl *template.Template, ev engine.Version) *export.Export
}

type TargetBuilder

type TargetBuilder[T Exporter] interface {
	Build(rc *run.Context, dst T) error
}

type TargetPlatforms

type TargetPlatforms struct {
	Linux   linux.TargetWithFeaturesAndProfile   `toml:"linux"`
	MacOS   macos.TargetWithFeaturesAndProfile   `toml:"macos"`
	Windows windows.TargetWithFeaturesAndProfile `toml:"windows"`
}

type Targets

type Targets struct {
	*common.TargetWithFeaturesAndProfile

	Platform TargetPlatforms `toml:"platform"`
}

Targets defines the parameters for exporting a game binary or pack file for a specified platform. A 'Target' definition can be customized based on 'feature', 'platform', and 'profile' labels used in the property names. Note that each specifier label can only be used once per property name (i.e. 'target.profile.release.profile.debug' is not allowed). Additionally, the order of specifiers is strict: 'platform' < 'feature' < 'profile'.

For example, the following are all valid table names:

[target]
[target.profile.release]
[target.platform.macos.feature.client]
[target.platform.linux.feature.server.profile.release_debug]

func (Targets) Combine

func (t Targets) Combine(rc *run.Context) (Exporter, error)

type TemplateBuilder

type TemplateBuilder[T Templater] interface {
	Build(rc *run.Context, dst T) error
}

type TemplatePlatforms

type TemplatePlatforms struct {
	Linux   linux.TemplateWithFeaturesAndProfile   `toml:"linux"`
	MacOS   macos.TemplateWithFeaturesAndProfile   `toml:"macos"`
	Windows windows.TemplateWithFeaturesAndProfile `toml:"windows"`
}

type Templater

type Templater interface {
	config.Configurable[*run.Context]

	Collect(src engine.Source, rc *run.Context) *template.Template
}

type Templates

type Templates struct {
	*common.TemplateWithFeaturesAndProfile

	Platform TemplatePlatforms `toml:"platform"`
}

Templates defines the parameters for building a Godot export template for a specified platform. A 'Template' definition can be customized based on 'feature', 'platform', and 'profile' labels used in the property names. Note that each specifier label can only be used once per property name (i.e. 'target.profile.release.profile.debug' is not allowed). Additionally, the order of specifiers is strict: 'platform' < 'feature' < 'profile'.

For example, the following are all valid table names:

[template]
[template.profile.release]
[template.platform.macos.feature.client]
[template.platform.linux.feature.server.profile.release_debug]

func (*Templates) Combine

func (t *Templates) Combine(rc *run.Context) (Templater, error)