Annotations

Core Language View source
Annotations

Source on GitHub

Functions

annotation

public function annotation()

This annotation allows this function to be used as an annotation.

compiletime

public function compiletime()

This annotation means that this function will be executed when the map is compiled.

deprecated

public function deprecated()

This annotation means that this function should no longer be used.

deprecated

public function deprecated(string _message)

This annotation means that this function should no longer be used. The corresponding message is a hint for which function to use instead.

compiletimenative

public function compiletimenative()

Functions annotated with @compiletimenative are natives that are only available at compiletime, but not ingame.

configurable

public function configurable()

Elements annotated with @configurable can be configured (i.e. replaced by a different implementation) in configuration packages.

inline

public function inline()

Functions annotated with @inline will have a higher priority of being inlined by the optimizer.

noinline

public function noinline()

Functions annotated with @inline will have a lower priority of being inlined by the optimizer.

config

public function config()

Elements annotated with @config configure an element in the correspoding package (i.e. replaced by a different implementation).

extern

public function extern()

Functions annotated with @extern are assumed to be defined in external sources and are thus not included in the compilation output.

ifnotdefined

public function ifnotdefined()

Functions annotated with @ifNotDefined are only output into the mapscript if they don’t already exist.