wiki.sine.space | sinespace
Open Nav

Difference between revisions of "Scripting/SCharacterController"

From wiki.sine.space
Jump to: navigation, search
Line 46: Line 46:
 
}}
 
}}
  
−
{{ScriptFunction|bool|DetectCollisions|{get; set;}|Determines whether other rigid bodies or character controllers collide with this character controller (by default this is always enabled).|5=
+
{{ScriptFunction|bool|DetectCollisions|{get; set;}|Determines whether other rigidbodies or character controllers collide with this character controller (by default this is always enabled).
−
local Object = Space.Scene.Find("SCRIPT_OBJECT")<br>
+
 
−
local Vectordata = Object.CharacterController.DetectCollisions<br>
+
This method does not affect collisions detected during the character controller's movement but rather decides whether an incoming collider will be blocked by the controller's collider. For example, a box collider in the Scene will block the movement of the controller, but the box may still fall through the controller if detectCollisions is false. This property is useful to disable the character controller temporarily. For example, you might want to mount a character into a car and disable collision detection until it exits the car again.|5=<pre>
−
Space.Log(Vectordata)
+
Space.Host.CharacterController.DetectCollisions= false</pre>|6=<pre>--clicking this object will toggle a Character Controller's Detect Collisions property
 +
 
 +
thisObject = Space.Host.ExecutingObject
 +
ccontroller = Space.Host.GetReference("thecharactercontroller").CharacterController --add Reference to Scripting Runtime
 +
 
 +
 
 +
function OnClickFunction()
 +
ccontroller.DetectCollisions = not ccontroller.DetectCollisions
 +
end
 +
 
 +
thisObject.AddClickable()
 +
thisObject.Clickable.OnClick(OnClickFunction)</pre>
 
}}
 
}}
  
−
{{ScriptFunction|bool|EnableOverlapRecovery|{get; set;}|Enables or disables overlap recovery.|5=
+
{{ScriptFunction|bool|EnableOverlapRecovery|{get; set;}|Enables or disables overlap recovery. Enables or disables overlap recovery. Used to depenetrate character controllers from static objects when an overlap is detected.
−
local Object = Space.Scene.Find("SCRIPT_OBJECT")<br>
+
 
−
local Vectordata = Object.CharacterController.enableOverlapRecovery<br>
+
Overlap recovery can be used to depenetrate character controllers (CCTs) from static objects when an overlap is detected. This can happen in three main cases:
−
Space.Log(Vectordata)
+
 
 +
- when the CCT is directly spawned or teleported in another object
 +
 
 +
- when the CCT algorithm fails due to limited FPU accuracy
 +
 
 +
- when the "up vector" is modified, making the rotated CCT shape overlap surrounding objects
 +
 
 +
When activated, the CCT module will automatically try to resolve the penetration, and move the CCT to a safe place where it does
 +
 
 +
not overlap other objects anymore. This only concerns static objects, dynamic objects are ignored by overlap recovery.
 +
 
 +
When overlap recovery is not activated, it is possible for the CCTs to go through static objects. By default, overlap recovery is enabled.
 +
 
 +
Overlap recovery currently works with all geometries except heightfields.|5=<pre>
 +
Space.Host.CharacterController.EnableOverlapRecovery= false</pre>|6=<pre>--clicking this object will toggle a Character Controller's Enable Overlap Recovery property
 +
 
 +
thisObject = Space.Host.ExecutingObject
 +
ccontroller = Space.Host.GetReference("thecharactercontroller").CharacterController --add Reference to Scripting Runtime
 +
 
 +
 
 +
function OnClickFunction()
 +
ccontroller.EnableOverlapRecovery = not ccontroller.EnableOverlapRecovery
 +
end
 +
 
 +
thisObject.AddClickable()
 +
thisObject.Clickable.OnClick(OnClickFunction)</pre>
 
}}
 
}}
  

Revision as of 08:47, 25 January 2022

Members

ClosestPointOnBounds

SVector ClosestPointOnBounds (SVector position);

The closest point to the bounding box of the attached collider. This can be used to calculate hit points when applying explosion damage.

function PrintVector (data)

    Space.Log(data.X)
    Space.Log(data.Y)
    Space.Log(data.Z)
end
local Object = Space.Scene.Find("SCRIPT_OBJECT")
local newVector = Vector.New(5,5,5)
local Vectordata = Object.CharacterController.ClosestPointOnBounds(newVector)

PrintVector(Vectordata)


ClosestPoint

SVector ClosestPoint (SVector position);

The point on the collider that is closest to the specified location.

function PrintVector (data)

    Space.Log(data.X)
    Space.Log(data.Y)
    Space.Log(data.Z)
end
local Object = Space.Scene.Find("SCRIPT_OBJECT")
local newVector = Vector.New(5,5,5)

local Vectordata = Object.CharacterController.ClosestPoint(newVector)
PrintVector(Vectordata)


SimpleMove

bool SimpleMove (SVector speed)

Moves the character with speed.

local Object = Space.Scene.Find("SCRIPT_OBJECT")

local newVector = Vector.New(100,0,0)
local Vectordata = Object.CharacterController.SimpleMove(newVector)

Space.Log(Vectordata)


Move

int Move (SVector motion)

Moves the character with speed.

local Object = Space.Scene.Find("SCRIPT_OBJECT")

local newVector = Vector.New(100,0,0)
local Vectordata = Object.CharacterController.Move(newVector)

Space.Log(Vectordata)


Properties

Center

SVector Center {get; set;}

Returns Center Vector value of the Character Controller.

local Object = Space.Scene.Find("SCRIPT_OBJECT")
Space.Log(Object.CharacterController.Center.X)


DetectCollisions

bool DetectCollisions {get; set;}

Determines whether other rigidbodies or character controllers collide with this character controller (by default this is always enabled).

This method does not affect collisions detected during the character controller's movement but rather decides whether an incoming collider will be blocked by the controller's collider. For example, a box collider in the Scene will block the movement of the controller, but the box may still fall through the controller if detectCollisions is false. This property is useful to disable the character controller temporarily. For example, you might want to mount a character into a car and disable collision detection until it exits the car again. 

Space.Host.CharacterController.DetectCollisions= false


--clicking this object will toggle a Character Controller's Detect Collisions property

thisObject = Space.Host.ExecutingObject
ccontroller = Space.Host.GetReference("thecharactercontroller").CharacterController --add Reference to Scripting Runtime


function OnClickFunction()
ccontroller.DetectCollisions = not ccontroller.DetectCollisions
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

EnableOverlapRecovery

bool EnableOverlapRecovery {get; set;}

Enables or disables overlap recovery. Enables or disables overlap recovery. Used to depenetrate character controllers from static objects when an overlap is detected.

Overlap recovery can be used to depenetrate character controllers (CCTs) from static objects when an overlap is detected. This can happen in three main cases:

- when the CCT is directly spawned or teleported in another object

- when the CCT algorithm fails due to limited FPU accuracy

- when the "up vector" is modified, making the rotated CCT shape overlap surrounding objects

When activated, the CCT module will automatically try to resolve the penetration, and move the CCT to a safe place where it does

not overlap other objects anymore. This only concerns static objects, dynamic objects are ignored by overlap recovery.

When overlap recovery is not activated, it is possible for the CCTs to go through static objects. By default, overlap recovery is enabled.

Overlap recovery currently works with all geometries except heightfields. 

Space.Host.CharacterController.EnableOverlapRecovery= false


--clicking this object will toggle a Character Controller's Enable Overlap Recovery property

thisObject = Space.Host.ExecutingObject
ccontroller = Space.Host.GetReference("thecharactercontroller").CharacterController --add Reference to Scripting Runtime


function OnClickFunction()
ccontroller.EnableOverlapRecovery = not ccontroller.EnableOverlapRecovery
end

thisObject.AddClickable()
thisObject.Clickable.OnClick(OnClickFunction)

Height

float Height {get; set;}

The height of the character's capsule. 

Space.Host.ExecutingObject.CharacterController.Height = 4


--the below script will make a slider change a Character Controller Height property
--[Add "theslider" and "thecharactercontroller" to the Object References section in Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider 
ccontroller = Space.Host.GetReference("thecharactercontroller").CharacterController 


OVC = function()
ccontroller.Height = (slider.Value * 10.0) -- from 0.0 to 10.0
end

slider.OnValueChanged(OVC)

MinMoveDistance

float MinMoveDistance {get; set;}

Gets or sets the minimum move distance of the character controller. 

Space.Host.ExecutingObject.CharacterController.MinMoveDistance = 3


--this script will make a slider change a Character Controller Min Move Distance property
--[Add "theslider" and "thecharactercontroller" to the Object References section in Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider 
ccontroller = Space.Host.GetReference("thecharactercontroller").CharacterController 


OVC = function()
ccontroller.MinMoveDistance= (slider.Value * 10.0) -- from 0.0 to 10.0
end

slider.OnValueChanged(OVC)

Radius

float Radius {get; set;}

The radius of the character's capsule. 

Space.Host.ExecutingObject.CharacterController.Radius = 5


--this script will make a slider change a Character Controller Radius property
--[Add "theslider" and "thecharactercontroller" to the Object References section in Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider 
ccontroller = Space.Host.GetReference("thecharactercontroller").CharacterController 


OVC = function()
ccontroller.Radius= (slider.Value * 10.0) -- from 0.0 to 10.0
end

slider.OnValueChanged(OVC)

SkinWidth

float SkinWidth {get; set;}

The character's collision skin width. 

Space.Host.ExecutingObject.CharacterController.SkinWidth = 4


--this script will make a slider change a Character Controller SkinWidth property
--[Add "theslider" and "thecharactercontroller" to the Object References section in Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider 
ccontroller = Space.Host.GetReference("thecharactercontroller").CharacterController 


OVC = function()
ccontroller.SkinWidth= (slider.Value * 10.0) -- from 0.0 to 10.0
end

slider.OnValueChanged(OVC)

SlopeLimit

float SlopeLimit {get; set;}

The character controllers slope limit in degrees. 

Space.Host.ExecutingObject.CharacterController.SlopeLimit= 2


--this script will make a slider change a Character Controller Slope Limit property
--[Add "theslider" and "thecharactercontroller" to the Object References section in Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider 
ccontroller = Space.Host.GetReference("thecharactercontroller").CharacterController 


OVC = function()
ccontroller.SlopeLimit= (slider.Value * 180.0) -- from 0.0 to 180.0
end

slider.OnValueChanged(OVC)

StepOffset

float StepOffset {get; set;}

The character controllers step offset in meters. 

Space.Host.ExecutingObject.CharacterController.StepOffset= 2


--this script will make a slider change a Character Controller Step Offset property
--[Add "theslider" and "thecharactercontroller" to the Object References section in Scripting Runtime component]

slider = Space.Host.GetReference("theslider").UISlider 
ccontroller = Space.Host.GetReference("thecharactercontroller").CharacterController 


OVC = function()
ccontroller.StepOffset= (slider.Value * 10.0) -- from 0.0 to 10.0
end

slider.OnValueChanged(OVC)

Velocity

SVector Velocity { get; set; }

The current relative velocity of the Character.

function PrintVector (data)

    Space.Log(data.X)
    Space.Log(data.Y)
    Space.Log(data.Z)
end
local Object = Space.Scene.Find("SCRIPT_OBJECT")
local newVector = Vector.New(5,5,5)
local Vectordata = Object.CharacterController.Velocity

PrintVector(Vectordata)


v · d · e
Scripting Portal
Common
Key Classes
Helper Classes
Scripting samples and tutorials
Retrieved from "https://wiki.sine.space/index.php?title=Scripting/SCharacterController&oldid=200133"