Flora proxy (self.flora)

Bound on script tables as self.flora. Only these members are available; unknown names are rejected.

Source: Utils/Lua/LuaFloraApi.cs.

Properties

Name	Lua type	Access	Notes
Id	string or nil	Read-only	Read a stable key for this runtime plant across different Lua views. Opaque ID, or nil when absent. Suitable for Lua table keys; changes when the object is recreated and is not a save or network identifier.
IsDead	boolean	Read-only	Read the engine's plant-removal flag. True when the plant is marked dead; false when absent. Breaking into a surviving stump does not necessarily mark it dead.
IsPlayer	boolean	Read-only	Distinguish players from plants. Always false for flora.
IsValid	boolean	Read-only	Check whether this plant remains present in the current Lua world. False when absent, dead, removed, replaced, or in another world.
TypeId	string or nil	Read-only	Read the plant's registered content identity. Namespaced flora ID accepted by World.createFlora, or nil when absent or unregistered. Distinct from the shared FloraType growth profile.

Methods

Lua call	Arguments	Returns	Notes
self.flora:ApplyCharMap(charMapName)	charMapName: string — Authored Spriter character-map name.	no return value	Apply an authored Spriter character map. Does nothing when the plant is absent.
self.flora:GetGlobalBonePosition(boneName)	boneName: string — Authored bone name.	Vector2 — World position as a Vector2 value copy; (0, 0) when the plant is absent.	Read a Spriter plant bone position in world pixels.
self.flora:HasTag(tag)	tag: string — Authored tag string.	boolean — False when the host is absent or does not support this operation.	Check an exact, case-sensitive authored plant tag.
self.flora:IsFullyGrown()	None	boolean — False when the host is absent or does not support this operation.	Check whether the plant is fully grown.
self.flora:IsViable()	None	boolean — False when the host is absent or does not support this operation.	Check whether the plant is viable.
self.flora:PlayParticleEffectOnce(key, emitPoint)	key: string — Authored particle-effect key. emitPoint: Vector2 — Emission position in world pixels.	no return value	Trigger an authored plant particle-effect key once at a world position. Missing keys and absent plants do nothing.
self.flora:RemoveCharMap(charMapName)	charMapName: string — Authored Spriter character-map name.	no return value	Remove an authored Spriter character map. Does nothing when the plant is absent.

CLR declaration reference

These names identify the backing engine source declarations.

• string Id
• bool IsDead
• bool IsPlayer
• bool IsValid
• string TypeId
• void ApplyCharMap(String charMapName)
• Vector2 GetGlobalBonePosition(String boneName)
• Boolean HasTag(String tag)
• Boolean IsFullyGrown()
• Boolean IsViable()
• void PlayParticleEffectOnce(String key, Vector2 emitPoint)
• void RemoveCharMap(String charMapName)

Generated 2026-10-02T21:05:27.5090099Z · b8c9ae78 · 12 members.

Official modding overview · Signs of Life on Steam