Class WorldSquad
Core system that renders the level/background blocks and load the world data into stage
Implements
Properties
Behind
Squad that handles the behind side map
Declaration
public static WorldSquad Behind { get; set; }Enable
True if the system is required
Declaration
public static bool Enable { get; set; }Front
Squad that handles the front side map
Declaration
public static WorldSquad Front { get; set; }SquadReady
True if the system is ready to use
Declaration
public static bool SquadReady { get; }Methods
AddBlockRedirect(int, int)
Add a pair of redirect ID to make all "fromID" block rendered with "toID"
Declaration
public static void AddBlockRedirect(int fromID, int toID)ClearStreamWorldPool()
Reset the internal world instance pool
Declaration
public static void ClearStreamWorldPool()GetAllBlocksAt(int, int, int)
Get all ID of blocks at given unit position
Declaration
public (int level, int bg, int entity, int element) GetAllBlocksAt(int unitX, int unitY, int z)Parameters
| Type | Name | Description |
|---|---|---|
| int | unitX | Position in unit space |
| int | unitY | Position in unit space |
| int | z | Z position |
GetBlockAt(int, int, BlockType)
Get block ID at given unit position
Declaration
public int GetBlockAt(int unitX, int unitY, BlockType type)Parameters
| Type | Name | Description |
|---|---|---|
| int | unitX | Position in unit space |
| int | unitY | Position in unit space |
| BlockType | type | Type of the block |
GetBlockAt(int, int, int, BlockType)
Get block ID at given unit position
Declaration
public int GetBlockAt(int unitX, int unitY, int z, BlockType type)Parameters
| Type | Name | Description |
|---|---|---|
| int | unitX | Position in unit space |
| int | unitY | Position in unit space |
| int | z | Position Z |
| BlockType | type | Type of the block |
RemoveBlockRedirect(int)
Remove the redirect pair
Declaration
public static bool RemoveBlockRedirect(int fromID)Returns
| Type | Description |
|---|---|
| bool | True if the pair removed |
ResetStreamFailbackCopying()
Make all existing user maps require reload from built-in maps without deleting the user map folder
Declaration
public static void ResetStreamFailbackCopying()SetBlockAt(int, int, int, BlockType, int)
Set block ID at given unit position
Declaration
public void SetBlockAt(int unitX, int unitY, int z, BlockType type, int newID)Parameters
| Type | Name | Description |
|---|---|---|
| int | unitX | Position in unit space |
| int | unitY | Position in unit space |
| int | z | Position Z |
| BlockType | type | Type of the block |
| int | newID | ID of the block |
WorldExists(Int3)
True if world exists at given world position
Declaration
public bool WorldExists(Int3 worldPos)Parameters
| Type | Name | Description |
|---|---|---|
| Int3 | worldPos | In world space (1 world space = 256 * 128 global space) |