Skip to content

Project API

Jason Perkins edited this page Jun 8, 2015 · 35 revisions

Core APIs

API Brief
_ACTION The action that will be run
_ARGS Array of action args
_MAIN_SCRIPT
_MAIN_SCRIPT_DIR
_OPTIONS
_PREMAKE_COMMAND
_PREMAKE_DIR
_PREMAKE_VERSION The version of the currently executing instance of Premake
_WORKING_DIR
architecture
atl Use Microsoft's Active Template Library
basedir
buildaction
buildcommands
builddependencies
buildinputs
buildlog
buildmessage
buildoptions Additional build options (passed directly to compiler)
buildoutputs
cleancommands
cleanextensions
clr Use Microsoft's Common Language Runtime
configfile
configuration
configurations
configmap
copylocal
debugargs
debugcommand
debugconnectcommands Debugger commands to execute on remote target connection
debugdir Working directory for debug session
debugenvs Env vars for debug session
debugextendedprotocol Use gdb 'extended' protocol; maintain a persistent connection
debugformat Format for embedded debug information
debugport Port to use for remote debugging
debugremotehost Target for remote debugging
debugsearchpaths Search paths for source code while debugging
debugstartupcommands Debugger commands to execute on debugger startup
defaultplatform
defines
dependson
deploymentoptions
disablewarnings
display
editandcontinue
enablewarnings
endian
external
externalRule
fatalwarnings
fileextension
filename
files
filter
flags
floatingpoint
forceincludes
forceusings
fpu
framework
gccprefix
group
icon
imageoptions
imagepath
implibdir
implibextension
implibname
implibprefix
implibsuffix
includedirs
include
includeexternal
kind
language
libdirs
linkoptions Additional linker options (passed directly to linker)
links
locale
location
makesettings
namespace
nativewchar
objdir Output dir for object/intermediate files
optimize Optimization level
pchheader Precompiled header file
pchsource Precompiled header source file (which should build the PCH)
pic Position independent code
platforms
postbuildcommands
postbuildmessage
prebuildcommands
prebuildmessage
prelinkcommands
prelinkmessage
project
propertydefinition
[rebuildcommands](rebuild commands)
resdefines
resincludedirs
resoptions
rule
rules
runtime
solution
startproject
strictaliasing
sysincludedirs
syslibdirs
system
targetdir
targetextension
targetname
targetprefix
targetsuffix
toolset
undefines
usingdirs
uuid Set project GUID (for VS projects/solutions)
vectorextensions Enable hardware vector extensions
vpaths
warnings

Builtin Extension APIs

The following API reference is for use with various built-in extensions.

D language APIs Brief
debugconstants Declare debug identifiers
debuglevel Declare debug level
docdir Output dir for ddoc generation
docname Filename for the ddoc output
headerdir Output dir for interface file generation
headername Filename for the interface (.di) file
versionconstants Declare version identifiers
versionlevel Declare version level

Clone this wiki locally