Table Objects
-Moveables, statics, cameras, and so on.
+Objects including moveables, statics, cameras, and others.
diff --git a/Documentation/doc/2 classes/Objects.Moveable.html b/Documentation/doc/2 classes/Objects.Moveable.html index 1e6f612e2..63a80a38c 100644 --- a/Documentation/doc/2 classes/Objects.Moveable.html +++ b/Documentation/doc/2 classes/Objects.Moveable.html @@ -108,7 +108,7 @@
Class Objects.Moveable
Represents a moveable object in the game world.
-Examples include traps, enemies, doors, pickups, and the player. See also Objects.LaraObject for player-specific features.
+Examples include the player, traps, enemies, doors, and pickups. See also Objects.LaraObject for player-specific features.
pragma nostrip
@@ -436,7 +436,7 @@ most can just be ignored (see usage).Class Objects.Static
-Statics
+Represents a static object in the game world.
@@ -115,88 +115,85 @@
Functions
Static:Enable() | -Enable the static, for cases when it was shattered or manually disabled before. | -||
Static:Disable() | -Disable the static | -||
Static:GetActive() | -Get static mesh visibility | -||
Static:GetSolid() | -Get static mesh solid collision state | -||
Static:SetSolid(solidState) | -Set static mesh solid collision state | -||
Static:GetPosition() | -Get the static's position | -||
Static:SetPosition(position) | -Set the static's position | -||
Static:GetRotation() | -Get the static's rotation | -||
Static:SetRotation(rotation) | -Set the static's rotation | -||
Static:GetScale() | -Get the static's scale | -||
Static:SetScale(scale) | -Set the static's scale | -||
Static:GetHP() | -Get current HP (hit points/health points) - Used only with shatterable static meshes. | -||
Static:SetHP(HP) | -Set current HP (hit points/health points) - Used only with shatterable static meshes. | -||
Static:GetName() | -Get the static's unique string identifier | -||
Static:SetName(name) | -Set the static's name (its unique string identifier) - e.g. | +Get this static's unique string identifier. | |
Static:GetSlot() | -Get the static's slot number (as listed in Tomb Editor and WadTool) | +Get this static's slot ID. | |
Static:SetSlot(slot) | -Set the static's slot number (as listed in Tomb Editor and WadTool) | +Static:GetPosition() | +Get this static's world position. | +
Static:GetRotation() | +Get this static's world rotation. | +||
Static:GetScale() | +Get this static's world scale. | ||
Static:GetColor() | -Get the static's color | +Get this static's color. | +|
Static:GetHP() | +Get this static's hit points. | +||
Static:GetActive() | +Get this static's visibility state. | +||
Static:GetSolid() | +Get this static's solid collision state. | +||
Static:SetName(name) | +Set this static's unique identifier string. | +||
Static:SetSlot(New) | +Set this static's slot ID. | +||
Static:SetPosition(New) | +Set this static's world position. | +||
Static:SetRotation(New) | +Set this static's rotation. | +||
Static:SetScale(New) | +Set this static's world scale. | ||
Static:SetColor(color) | Set the static's color | ||
Static:SetHP(New) | +Set this static's hit points. | +||
Static:SetSolid(Solid) | +Set this static's solid collision state. | +||
Static:Enable() | +Enable this static. | +||
Static:Disable() | +Disable this static. | +||
Static:Shatter() | -Shatter static mesh | +Shatter this static. |
- - - Static:Enable() + + Static:GetName()
-
- Enable the static, for cases when it was shattered or manually disabled before.
+ Get this static's unique string identifier.
+
Returns:
+-
+
+ string
+ Name string.
+
- - - Static:Disable() + + Static:GetSlot()
-
- Disable the static
+ Get this static's slot ID.
+
Returns:
+-
+
+ int
+ Slot ID.
+
+ - + + Static:GetPosition() + +
-
+ Get this static's world position.
+
+
+
+
+
Returns:
+-
+
+ Vec3
+ World position.
+
+ - + + Static:GetRotation() + +
-
+ Get this static's world rotation.
+
+
+
+
+
Returns:
+-
+
+ Rotation
+ World rotation.
+
+ - + + Static:GetScale() + +
-
+ Get this static's world scale.
+
+
+
+
+
Returns:
+-
+
+ float
+ World scale.
+
+ - + + Static:GetColor() + +
-
+ Get this static's color.
+
+
+
+
+
Returns:
+-
+
+ Color
+ Color.
+
+ - + + Static:GetHP() + +
-
+ Get this static's hit points. Used only with shatterable statics.
+
+
+
+
+
Returns:
+-
+
+ int
+ Hit points.
+
- - Get static mesh visibility + Get this static's visibility state. @@ -251,7 +365,7 @@
-
bool
- visibility state
+ Visibility state.
- - Get static mesh solid collision state + Get this static's solid collision state. @@ -272,224 +386,7 @@
--
bool
- solid collision state (true if solid, false if soft)
-
- - Get static mesh visibility + Get this static's visibility state. @@ -251,7 +365,7 @@
- - - Static:SetSolid(solidState) - -
-
- Set static mesh solid collision state
-
-
-
-
Parameters:
--
-
- solidState - bool - if set, collision will be solid, if not, will be soft - -
- - - - Static:GetPosition() - -
-
- Get the static's position
-
-
-
-
-
Returns:
--
-
- Vec3
- a copy of the static's position
-
- - - - Static:SetPosition(position) - -
-
- Set the static's position
-
-
-
-
Parameters:
--
-
- position - Vec3 - the new position of the static - -
- - - - Static:GetRotation() - -
-
- Get the static's rotation
-
-
-
-
-
Returns:
--
-
- Rotation
- a copy of the static's rotation
-
- - - - Static:SetRotation(rotation) - -
-
- Set the static's rotation
-
-
-
-
Parameters:
--
-
- rotation - Rotation - the static's new rotation - -
- - - - Static:GetScale() - -
-
- Get the static's scale
-
-
-
-
-
Returns:
--
-
- float
- current static scale
-
- - - - Static:SetScale(scale) - -
-
- Set the static's scale
-
-
-
-
Parameters:
--
-
- scale - Scale - the static's new scale - -
- - - - Static:GetHP() - -
-
- Get current HP (hit points/health points)
- Used only with shatterable static meshes.
-
-
-
-
-
Returns:
--
-
- int
- the amount of HP the static currently has
-
- - - - Static:SetHP(HP) - -
-
- Set current HP (hit points/health points)
- Used only with shatterable static meshes.
-
-
-
-
Parameters:
--
-
- HP - int - the amount of HP to give the static - -
- - - - Static:GetName() - -
-
- Get the static's unique string identifier
-
-
-
-
-
Returns:
--
-
- string
- the static's name
+ Solid collision state. True: solid, False: soft
- - Set the static's name (its unique string identifier) - e.g. "my_vase" or "oldrubble" + Set this static's unique identifier string. @@ -510,7 +406,7 @@
-- name string - The static's new name + New name.
- - Set the static's name (its unique string identifier) - e.g. "my_vase" or "oldrubble" + Set this static's unique identifier string. @@ -510,7 +406,7 @@
- - - Static:GetSlot() - -
-
- Get the static's slot number (as listed in Tomb Editor and WadTool)
-
-
-
-
-
Returns:
--
-
- string
- the static's slot number
-
- - Static:SetSlot(slot) + Static:SetSlot(New)
-
- Set the static's slot number (as listed in Tomb Editor and WadTool)
+ Set this static's slot ID.
Parameters:
-
-
- slot +
- New int - The static's slot number + slot ID.
- - - Static:GetColor() + + Static:SetPosition(New)
-
- Get the static's color
+ Set this static's world position.
+
+
+
+
Parameters:
+-
+
- New + Vec3 + world position. + +
Returns:
--
- Color
- a copy of the static's color
-
+ - + + Static:SetRotation(New) + +
-
+ Set this static's rotation.
+
+
+
+
Parameters:
+-
+
- New + Rotation + rotation. + +
+ - + + Static:SetScale(New) + +
-
+ Set this static's world scale.
+
+
+
+
Parameters:
+-
+
- New + Scale + world scale. + +
+ - + + Static:SetHP(New) + +
-
+ Set this static's hit points. Used only with shatterable statics.
+
+
+
+
Parameters:
+-
+
- New + int + hit points. + +
+ - + + Static:SetSolid(Solid) + +
-
+ Set this static's solid collision state.
+
+
+
+
Parameters:
+-
+
- Solid + bool + collision state. True: solid, False: soft + +
+ - + + Static:Enable() + +
- + Enable this static. Used when previously shattered disabled manually. + + + + + + + + + +
- + + Static:Disable() + +
- + Disable this static. + + + + + + + +
- Static:Shatter()
- - Shatter static mesh + Shatter this static. diff --git a/Documentation/doc/index.html b/Documentation/doc/index.html index d0f8c98d0..6af8aaac3 100644 --- a/Documentation/doc/index.html +++ b/Documentation/doc/index.html @@ -153,7 +153,7 @@ local door = GetMoveableByName("door_type4_14")