World
The current World Modbox is in. Values are saved with the World
Create
| Name | Type | Description |
|---|---|---|
| Create Entity: Entity From Asset(Entity Asset entAsset, Vector3 position, Vector3 rotation, Start Ent Mode startMode) | Entity | Create a new Entity from a Entity asset |
| Create Entity: Clone Entity(Entity toClone, Start Ent Mode startMode) | Entity | Clone Entity - keeping it's data and setting a new ID |
| Create Entity: Clone Entities(Entity List toClone, Start Ent Mode startMode) | Entity List | Clone a list of Entities |
| Create Entity: Replace Entity(Entity toReplace, Entity Asset withAsset, Replace Ent Mode replaceMode) | Entity | Replace a existing Entity with a new one, keeping it's ID (so any references to it in the world are kept) and optional it's Data |
| Create Entity: Create Stored Entity(Stored Entities data, Start Ent Mode startMode) | Entity | Create a Entity from StoredEntity data |
| Create Entity: Create Under World Entity(Entity Asset entAsset, Entity underEntity, Start Ent Mode startMode) | Entity | Create a Entity and set it as a child of a existing Entity |
| Create Entity: Create New Group(Entity List withEntities) | Entity | Creates a Group entity as a parent of the given Entities |
| Create Entity: Create Entity From Transform Part(Transform Part transformChild) | Entity |
Values
| Name | Type | Description |
|---|---|---|
| Sky: Skybox Material | Material Variable | |
| Sky: Sun Color | Color Variable | |
| Sky: Sun Intensity | Number Variable | x |
| Sky: Sun Angle | Vector3 Variable | |
| Sky: Ambient Equator Color | Color Variable | |
| Sky: Ambient Ground Color | Color Variable | |
| Sky: Ambient Intensity | Number Variable | x |
| Sky: Ambient Light | Color Variable | |
| Sky: Ambient Mode | Enum Variable | |
| Sky: Ambient Sky Color | Color Variable | |
| Sky: Fog | Bool Variable | |
| Sky: Fog Color | Color Variable | |
| Sky: Fog Density | Number Variable | x |
| Sky: Fog End Distance | Number Variable | m |
| Sky: Fog Mode | Enum Variable | |
| Sky: Fog Start Distance | Number Variable | m |
| Radial Gravity Mod System Base: Radial Gravity | Bool Variable | |
| Audio: Music Track | Audioclip Variable | Will loop Audio as Music (with volume set by user's 'Music' audio setting) |
| Audio: Music Track Volume | Number Variable | Defaults to 1 - x |
| Audio: Music Track Playing | Bool Variable | Defaults to True |
| Misc: Editor Ignore Selection | Entity Variable List | List of Entities to ignore with pointer/mouse Selection and VR Tools |
| Environment: Environment | Environment Variable | |
| Environment: Post FX | Post FX Variable | |
| Environment: Post FX Weight | Number Variable | Defaults to 1 - x |
| Environment: Post FX In Editmode | Bool Variable | Defaults to True |
| Environment: Gravity | Number Variable | Defaults to 1 - x |
| Environment: Time Scale | Number Variable | Defaults to 1 - x |
| Environment: Start Height | Number Variable | m |
| Environment: Start Angle | Number Variable | degrees |
| Graphics: View Distance | Number Variable | Set how far the camera can see - could help performance in large creations - m |
| Graphics: Hide Environment Bounds | Bool Variable | |
| Graphics: Disable Shadows | Bool Variable | Disable all light shadows |
| Graphics: Set Shadow Distance | Bool Variable | |
| Graphics: Shadow Distance | Number Variable | m |
| Environment: Environment Size | Vector3 Variable | Environment size set by the current Environment - - ReadOnly |
| Game: Time Paused | Bool Variable | |
| Game: Game Over | Bool Variable | |
| Game: Remove Below Bounds | Number Variable | Will remove any physics bodies once below these bounds, if Gravity is on - Defaults to -100 |
| Environment: Ground Type | Enum Variable | |
| Environment: Ground Material | Material Variable | |
| Environment: Wall Type | Enum Variable | |
| Environment: Wall Material | Material Variable | |
| Environment: Wall Height | Number Variable | Defaults to 1 - x |
| Environment: Water Plane | Bool Variable | |
| Environment: Env Size Y | Number Variable | Defaults to 15 - m |
| Environment: Env Size X | Number Variable | Defaults to 50 - m |
| Environment: Env Size Z | Number Variable | Defaults to 50 - m |
| Environment: Environment Scale | Number Variable | Defaults to 1 - x |
| Sky: Skybox | Skybox Variable | |
| Environment: Water Material | Material Variable | |
| Environment: Water Level | Number Variable | Defaults to -1 - m |
| Environment: Damage In Water | Bool Variable | |
| Environment: Damage Amount | Number Variable | Defaults to 10 - hp |
| Environment: Buoyancy | Number Variable | kn |
| Environment: Inside Post FX | Post FX Variable | |
| Game: Players Die Below Height | Number Variable | Players will die once below this height - Defaults to -20 |
| Game: Use Pathfinding | Bool Variable | |
| Game: Set Pathfinding Grid To Environment Size | Bool Variable | Defaults to True |
| Game: Pathfinding Grid Size | Vector2 Variable | |
| Game: Pathfinding Center | Vector2 Variable | |
| Game: Always Generate Grid | Bool Variable | Will always generate pathfinding grid on switching to Play mode after changes are made |
| Game: Generate Grid Next | Bool Variable | Will update pathfinding next Play mode |
| Game: Show Pathfinding Grid | Bool Variable |
Methods
| Name | Description |
|---|---|
| UI: Show Message(Text textToShow) | Print a message to all joined players |
| Audio: Play Audio At(Audio Clip clip, Vector3 pos) | Play Audio at Position |
| Audio: Play Audio(Audio Clip clip) | Play a Audio (2d) |
| Audio: Music Track Crossfade To(Audio Clip toTrack, Number speed) | Fade in a new music track over time |
| Create Entity: Entity From Asset(Entity Asset entAsset, Vector3 position, Vector3 rotation, Start Ent Mode startMode) | Create a new Entity from a Entity asset |
| Create Entity: Clone Entity(Entity toClone, Start Ent Mode startMode) | Clone Entity - keeping it's data and setting a new ID |
| Create Entity: Clone Entities(Entity List toClone, Start Ent Mode startMode) | Clone a list of Entities |
| Create Entity: Replace Entity(Entity toReplace, Entity Asset withAsset, Replace Ent Mode replaceMode) | Replace a existing Entity with a new one, keeping it's ID (so any references to it in the world are kept) and optional it's Data |
| Create Entity: Create Stored Entity(Stored Entities data, Start Ent Mode startMode) | Create a Entity from StoredEntity data |
| Create Entity: Create Under World Entity(Entity Asset entAsset, Entity underEntity, Start Ent Mode startMode) | Create a Entity and set it as a child of a existing Entity |
| Create Entity: Create New Group(Entity List withEntities) | Creates a Group entity as a parent of the given Entities |
| Create Entity: Create Entity From Transform Part(Transform Part transformChild) | |
| Editor: Clear World() | |
| Editor: Refresh All Connections() | |
| Entities: Remove Entities(Entity List removeEntities) | |
| Environment: Clear World(MB Widget Button) | |
| Game: Turn On Entity Playmode(Entity worldEnt) | |
| Game: Turn On Entities Playmode(Entity List ents) | |
| Dictionary: Add To Dictionary(Dictionary Variable Interface dictionary, Text key, Object of any Type value) | |
| Dictionary: Remove From Dictionary(Dictionary Variable Interface dictionary, Text key) | |
| Dictionary: Clear Dictionary(Dictionary Variable Interface dictionary) | |
| Ease: Ease To(MB Variable Value Ease To Interface onVar, Object of any Type to, Ease Type easeType, Number duration) | Eases a variable to a new value over time |
| Ease: Ease Stop(MB Variable Value Ease To Interface var) | |
| Effects: Play Effect(Effect effect, Vector3 position, Vector3 angle, Entity owner) | Play a Effect at Position |
| Effects: Play Effect With Scale(Effect effect, Vector3 position, Vector3 angle, Number scale, Entity owner) | |
| Effects: Play Effect Text(Text text, Vector3 position) | |
| Game: Fire Projectile(Projectile projectile, Vector3 position, Vector3 angle, Entity owner) | |
| Game: Rescan | |
| Game: Regenerate Grid Around Entity(Entity entity) | |
| Game: Generate New Graph() |
Events
| Name | Description |
|---|---|
| MBScript: Update Frame() | Ran every Frame (in Update()) |
| MBScript: Update Frame Fixed() | Ran every Frame (in FixedUpdate()) |
| Game: Playmode Started() | Runs when Playmode starts in the World |
| Players: User Joined Server(User user) | |
| Players: User Left Server(User user) | |
| Players: User Started Playmode(User user) | When a User starts in Play mode |
| Players: User Spawn Selected(User user) | User selected to Spawn / Respawn. Will check UserCanSpawnSelf event before spawning them |
| Players: User State Changed(User user) | Ran whenever a player in the world's state changed |
| Players: User Avatar Died(User user) | |
| Players: Player Avatar Set(Player Avatar player) | Called when a User is set to a Avatar |
| Players: User On Team Set(User user) | Called when a user's 'SetAvatarToTeam' is set |
| Players: User Killed User(User deadUser, User attacker) | |
| Players: User Killed Self(User user) |
Properties
| Name | Type | Description |
|---|---|---|
| Audio: Music Play Time | Number | |
| Audio: Music Is Playing | Bool | |
| Game: Time | Play Time | Time since start of the world's play mode |
| Entities: Entities From Asset(Entity Asset) | Entity List | |
| Entities: Entity By Ent ID(Whole Number) | Entity | |
| Entities: Components Of Type(MB Type Entity Component) | Entity Component List | |
| Entities: All Entities | Entity List | |
| Entities: Entity By Tag(Tag In Entity) | Entity | |
| Entities: Entities With Tag(Tag In Entity) | Entity List | |
| Entities: Entities Within Distance(Vector3, Number) | Entity List | |
| Entities: Components Within Distance(MB Type Entity Component, Vector3, Number) | Entity Component List | |
| Entities: Entities On Team(Team) | Team List | |
| Entities: All Toys | Toy List | |
| Physics: Raycast(Vector3, Vector3, Number, Bool) | Raycast Hit | |
| Physics: Raycast All(Vector3, Vector3, Number) | Raycast Hit List | |
| Physics: Box Cast(Vector3, Vector3, Vector3, Vector3, Number) | Raycast Hit | |
| Physics: Boxcast All(Vector3, Vector3, Vector3, Vector3, Number) | Raycast Hit List | |
| Physics: Sphere Cast(Vector3, Number, Vector3, Number, Bool) | Raycast Hit | |
| Physics: Sphere Cast All(Vector3, Number, Vector3, Number) | Raycast Hit List | |
| Physics: Overlap Box(Vector3, Vector3, Vector3) | Entity List | |
| Physics: Overlap Box Colliders(Vector3, Vector3, Vector3) | Collider Part List | |
| Physics: Overlap Sphere(Vector3, Number) | Entity List | |
| Physics: Overlap Sphere Colliders(Vector3, Number) | Collider Part List | |
| Game: In Play Mode | Bool | |
| Players: Main User | User | The host user |
| Players: Main Local User | User Local | The local main user. This will be different on other clients |
| Players: Main Local VR User | User VR Local | The local main VR user. This will be different on other clients |
| Players: Main Player Avatar | Player Avatar | The host user's player avatar |
| Players: All Users | User List | |
| Players: All Player Avatars | Player Avatar List | |
| Game: Grid Info | Text |
Return Value Events
| Name | Type | Description |
|---|---|---|
| Players: User Can Spawn Self(User user) | Bool | Return if a specific User can spawn themselves |
Updated almost 2 years ago