ReferenceBase¶

class guerilla.ReferenceBase¶

Bases: guerilla.HostNode

This class is the base class for referencing mechanisms

LoadHostReferences¶

If true, load the sub host references (references with no prefixes).

Type:	bool

Loaded¶

Tells if the reference is loaded or not. Must not be modified direclty.

Type:	bool

ReferenceActualFileName¶

The actual path of the referenced file, in case the reference path had to be resolved

Type:	str

ReferenceFileName¶

The path of the referenced file

Type:	str

ReferencePathOverride¶

The path override, so it possible to load another file instead of the original file

Type:	str

reload(filename, options=None)¶

Reload the reference from disk. Using the filename argument, the method will switch the reference for another one. The edits (modifications done on the reference) are re-applied after the reload.

Parameters:	filename (str) – The new reference filename. If None/nil, reload the previous reference file. options (table or None) – Options to merge over the current options. If None/nil, options are left unchanged
Returns:	Return true is the reference has been reloaded
Return type:	#bool

unload()¶

For internal use only.

Returns:	Unload a loaded top reference. Return true is the reference has been unloaded
Return type:	#bool