Camera
The camera is one of the basic elements within the project. The game camera is the tool that controls the player's point of view.
Functions
get_camera_by_scene_id
Get the camera by scene ID.
Parameter
Return
cli.get_camera_by_scene_id(scene_id)
get_camera_by_scene_id
Whether the player camera is playing an animation or not.
Parameter
Return
camera.get_camera_by_scene_id(player)
create_camera
Create a camera.
Parameters
Return
camera.create_camera(point, focal_length, focal_height, yaw, pitch, range_of_visibility)
apply_camera
Apply the camera.
Parameters
camera.apply_camera(player, camera, time, move_type)
enable_camera_move
Allow the player camera to move.
Parameter
camera.enable_camera_move(player)
disable_camera_move
Disable player camera movement.
Parameter
camera.disable_camera_move(player)
play_camera_timeline
Play the camera animation.
Parameters
camera.play_camera_timeline(player, camera_timeline_id)
stop_camera_timeline
Stop the camera animation.
Parameter
camera.stop_camera_timeline(player)
camera_shake_with_decay
Camera shake with decay.
Parameters
camera.camera_shake_with_decay(player, shake, attenuation, frequency, time, shake_type)
camera_shake
Camera shake camera.
Parameters
camera.camera_shake(player, strength, speed, time, shake_type)
linear_move_by_time
Linear move (time).
Parameters
camera.linear_move_by_time(player, point, time, move_type)
set_camera_follow_unit
Set the camera follow unit.
Parameters
camera.set_camera_follow_unit(player, unit, x, y, height)
cancel_camera_follow_unit
Set the camera to cancel following.
Parameter
camera.cancel_camera_follow_unit(player)
set_tps_follow_unit
Set the camera's third-person follow unit.
Parameters
camera.set_tps_follow_unit(player, unit, sensitivity, yaw, pitch, x_offset, y_offset, z_offset, camera_distance)
cancel_tps_follow_unit
Cancel the third-person follow unit of the camera.
Parameter
camera.cancel_tps_follow_unit(player)
look_at_point
Set the camera to face the point.
Parameters
camera.look_at_point(player, point, time)
set_max_distance
Set the maximum height of the camera.
Parameters
camera.set_max_distance(player, value)
set_rotate
Set the camera angle.
Parameters
camera.set_rotate(player, angle_type, value, time)
set_distance
Set the focus distance.
Parameters
camera.set_distance(player, value, time)
set_focus_height
Set the focus height of the camera.
Parameters
camera.set_focus_height(player, value, time)
limit_in_rectangle_area
Limit the camera movement area.
Parameters
camera.limit_in_rectangle_area(player, area)
cancel_area_limit
Turn off camera limit movement.
Parameter
camera.cancel_area_limit(player)
set_moving_with_mouse
Set whether the camera can be moved with the mouse.
Parameters
camera.set_moving_with_mouse(player, state)
set_mouse_move_camera_speed
Set the camera moving speed (mouse).
Parameters
camera.set_mouse_move_camera_speed(player, speed)
set_keyboard_move_camera_speed
Set the camera move speed (keyboard).
Parameters
camera.set_keyboard_move_camera_speed(player, speed)
get_player_camera_direction
Get the player camera direction.
Parameter
Return
camera.get_player_camera_direction(player)
get_camera_center_raycast
Get the collision point of the player's camera center ray.
Parameter
Return