Package mindustry.logic

Class GlobalVars

java.lang.Object

mindustry.logic.GlobalVars

public class GlobalVars
extends Object

Stores global logic variables for logic processors.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GlobalVars.VarEntry	An entry that describes a variable for documentation purposes.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ctrlCommand
static final int	ctrlPlayer
static final int	ctrlProcessor
static final ContentType[]	lookableContent
static final arc.math.Rand	rand	Global random state.
static final ContentType[]	writableLookableContent

Constructor Summary

Constructors

Constructor	Description
GlobalVars()

Method Summary

Modifier and Type	Method	Description
LVar	get(String name)
LVar	get(String name, boolean privileged)
arc.struct.Seq<GlobalVars.VarEntry>	getEntries()
void	init()
Object	lookupContent(ContentType type, int id)
int	lookupLogicId(UnlockableContent content)
LVar	put(String name, Object value)
LVar	put(String name, Object value, boolean privileged)	Adds a constant value by name.
LVar	put(String name, Object value, boolean privileged, boolean hidden)	Adds a constant value by name.
LVar	putEntry(String name, Object value)
LVar	putEntry(String name, Object value, boolean privileged)
void	putEntryOnly(String name)
void	remove(String name)
void	remove(LVar lvar)	Removes a global variable - used for data patch reset.
void	set(String name, double value)	Sets a global variable by name.
void	update()	Updates global time and other state variables.
LVar	waitVar()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ctrlProcessor

public static final int ctrlProcessor

See Also:

• Constant Field Values

ctrlPlayer

public static final int ctrlPlayer

See Also:

• Constant Field Values

ctrlCommand

public static final int ctrlCommand

See Also:

• Constant Field Values

lookableContent

public static final ContentType[] lookableContent

writableLookableContent

public static final ContentType[] writableLookableContent

rand

public static final arc.math.Rand rand

Global random state.

Constructor Details

GlobalVars

public GlobalVars()

Method Details

init

public void init()

update

public void update()

Updates global time and other state variables.

waitVar

public LVar waitVar()

getEntries

public arc.struct.Seq<GlobalVars.VarEntry> getEntries()

lookupContent

@Nullable
public Object lookupContent(ContentType type,
 int id)

Returns:

a piece of content based on its logic ID. This is not equivalent to content ID. In the case of teams, the return value may not be Content.

lookupLogicId

public int lookupLogicId(UnlockableContent content)

Returns:

the integer logic ID of content, or -1 if invalid.

get

@Nullable
public LVar get(String name)

Returns:

a constant variable if there is a constant with this name, or null.

get

@Nullable
public LVar get(String name,
 boolean privileged)

Returns:

a constant variable by name. Attempting to get privileged variable from a non-privileged logic executor returns a null constant.

set

public void set(String name,
 double value)

Sets a global variable by name.

put

public LVar put(String name,
 Object value,
 boolean privileged)

Adds a constant value by name.

put

public LVar put(String name,
 Object value,
 boolean privileged,
 boolean hidden)

Adds a constant value by name.

remove

public void remove(LVar lvar)

Removes a global variable - used for data patch reset. This variable is assumed not to be privileged or have a documentation entry.

remove

public void remove(String name)

put

public LVar put(String name,
 Object value)

putEntry

public LVar putEntry(String name,
 Object value)

putEntry

public LVar putEntry(String name,
 Object value,
 boolean privileged)

putEntryOnly

public void putEntryOnly(String name)