Difference between revisions of "ALiVE (Required)"
From ALiVE Wiki
| (15 intermediate revisions by 3 users not shown) | |||
| Line 6: | Line 6: | ||
==How It Works== | ==How It Works== | ||
| + | [[File:Alive required module.png|frame|alt=ALiVE Required Module|ALiVE (Required) Module]] | ||
| + | The main ALiVE module is required to make ALiVE work. It also includes settings for the built in Garbage Collector, Headless Client Support, Module Autopause and options to enable saving in Single Player missions. | ||
| − | |||
| + | ===Usage=== | ||
| + | Simply place ALiVE (Required) in the editor and choose the settings as desired. Do not sync it to anything. | ||
| − | |||
| + | ===Parameters=== | ||
| − | + | *'''''Debug:''''' Turn debug mode on/off. Allows for a better view of module's actions during mission creation/[[troubleshooting]]. TURN OFF WHEN DISTRIBUTING THE MISSION!! | |
| − | *''ALiVE Versioning:'' | + | *'''''ALiVE Versioning:''''' This will output a warning if players attempt to join a server with a different version of ALiVE. Optionally, editors can set it to Kick players as well. |
| − | *''AI Distribution:'' If Headless Client is selected, it will automatically distribute all AI spawned by ALiVE across available headless clients. | + | *'''''AI Distribution:''''' If Headless Client is selected, it will automatically distribute all AI spawned by ALiVE across available headless clients. If HC is chosen and no HC is present, units will fallback to server distributuion (NOT RECOMMENDED!!) |
| − | *''Disable SP Save:'' | + | *'''''Disable SP Save:''''' Regular saving in Single Player is disabled by default as the large amount of data in an ALiVE game can cause the client to crash on saving. Use Local Persistence in the ALiVE Data module instead. |
| − | *''Disable Adv Markers:'' | + | *'''''Disable Adv Markers:''''' Turns off the Advanced Marker system. This will also disable persistent markers, SPOTREPs and map drawing. |
| − | *''Disable Admin Actions:'' | + | *'''''Disable Admin Actions:''''' Turns off the admin actions such as ghosting, teleport and debug functions. |
| − | *''Autopause:'' | + | *'''''Autopause:''''' Freezes all active ALiVE modules when no players are connected to the server. For more control over pausing modules, see [http://alivemod.com/wiki/index.php/Script_Snippets#Pausing_Modules Script Snippets]. |
| − | *''Garbage Collector:'' | + | *'''''Garbage Collector:''''' The cycle time and lower threshold for when GC kicks in can be set here. Set to -1 to disable GC completely. |
| − | *''GC | + | *'''''GC Exclude:''''' Add classnames of any additional non-unit and non-vehicle objects to exclude from GC. Alternatively, it is also possible to exclude objects by syncing them to the ALiVE module or placing ''this setvariable ["ALiVE_SYS_GC_IGNORE",true]'' in the init line. |
| + | *'''''ALiVE Tablet Model''''' Select Tablet (default modern tablet) or Mapbag 1 for WW2 style map cover. | ||
| − | [[Category:ALiVE Modules]] | + | ==Admin Actions== |
| + | Admin Actions are available to Server Admins via the ALiVE Action Menu in game. | ||
| + | |||
| + | *'''''Activate Marking Units''''' will temporarily display the location of all units on the map. | ||
| + | |||
| + | *'''''Enable Ghosting''''' is a debug tool that will make the player unit invisible. | ||
| + | |||
| + | *'''''Enable Teleporting''''' is a debug tool that will teleport the player to any location. Usage: left click on the map to get TP to clicked location. | ||
| + | |||
| + | *'''''Teleport Units''''' can be used to teleport other units around the map. Vehicle crews will be teleported out of the vehicle. | ||
| + | |||
| + | *'''''Profile Units''''' can be used to Virtualise all units during runtime. Useful for units spawned by third party scripts or Zeus. Virtualised units will be taken over by the AI Commander on the next cycle. | ||
| + | |||
| + | *'''''Toggle OPCOM Installations''''' will show all existing Asymmetric installations such as IED factories and recruitment centres. Will also show objectives as CIV/MIL/STRATEGI | ||
| + | |||
| + | [[Category:ALiVE Modules]] [[Category:System Modules]] | ||
Latest revision as of 08:01, 31 May 2020
| Part of: | |||
|---|---|---|---|
| |||
How It Works
ALiVE (Required) Module
The main ALiVE module is required to make ALiVE work. It also includes settings for the built in Garbage Collector, Headless Client Support, Module Autopause and options to enable saving in Single Player missions.
Usage
Simply place ALiVE (Required) in the editor and choose the settings as desired. Do not sync it to anything.
Parameters
- Debug: Turn debug mode on/off. Allows for a better view of module's actions during mission creation/troubleshooting. TURN OFF WHEN DISTRIBUTING THE MISSION!!
- ALiVE Versioning: This will output a warning if players attempt to join a server with a different version of ALiVE. Optionally, editors can set it to Kick players as well.
- AI Distribution: If Headless Client is selected, it will automatically distribute all AI spawned by ALiVE across available headless clients. If HC is chosen and no HC is present, units will fallback to server distributuion (NOT RECOMMENDED!!)
- Disable SP Save: Regular saving in Single Player is disabled by default as the large amount of data in an ALiVE game can cause the client to crash on saving. Use Local Persistence in the ALiVE Data module instead.
- Disable Adv Markers: Turns off the Advanced Marker system. This will also disable persistent markers, SPOTREPs and map drawing.
- Disable Admin Actions: Turns off the admin actions such as ghosting, teleport and debug functions.
- Autopause: Freezes all active ALiVE modules when no players are connected to the server. For more control over pausing modules, see Script Snippets.
- Garbage Collector: The cycle time and lower threshold for when GC kicks in can be set here. Set to -1 to disable GC completely.
- GC Exclude: Add classnames of any additional non-unit and non-vehicle objects to exclude from GC. Alternatively, it is also possible to exclude objects by syncing them to the ALiVE module or placing this setvariable ["ALiVE_SYS_GC_IGNORE",true] in the init line.
- ALiVE Tablet Model Select Tablet (default modern tablet) or Mapbag 1 for WW2 style map cover.
Admin Actions
Admin Actions are available to Server Admins via the ALiVE Action Menu in game.
- Activate Marking Units will temporarily display the location of all units on the map.
- Enable Ghosting is a debug tool that will make the player unit invisible.
- Enable Teleporting is a debug tool that will teleport the player to any location. Usage: left click on the map to get TP to clicked location.
- Teleport Units can be used to teleport other units around the map. Vehicle crews will be teleported out of the vehicle.
- Profile Units can be used to Virtualise all units during runtime. Useful for units spawned by third party scripts or Zeus. Virtualised units will be taken over by the AI Commander on the next cycle.
- Toggle OPCOM Installations will show all existing Asymmetric installations such as IED factories and recruitment centres. Will also show objectives as CIV/MIL/STRATEGI
