Skip to content

Commit 1c120a8

Browse files
committed
Added a per-plugin README files
1 parent c587990 commit 1c120a8

File tree

5 files changed

+85
-0
lines changed

5 files changed

+85
-0
lines changed

plugins/arkit/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Godot iOS ARKit plugin
2+
3+
Uses Godot's `XRInterface`/`ARVRInterface` to handle iOS AR functionality.
4+
5+
## Methods
6+
7+
`set_light_estimation_is_enabled(bool flag)` - Sets a value responsible for usage of estimation of lighting conditions based on the camera image.
8+
`get_light_estimation_is_enabled()` - Returns a value responsible for usage of estimation of lighting conditions based on the camera image.
9+
`get_ambient_intensity()` - Returns a value used for intensity, in lumens, of ambient light throughout the scene.
10+
`get_ambient_color_temperature()` - Return a value used for color temperature of ambient light throughout the scene.
11+
`raycast(Vector2 screen_coords)` - Performs a raycast to search for real-world objects or AR anchors in the captured camera image.
12+
13+
## Properties
14+
15+
`light_estimation: bool` - Returns or sets a value responsible for usage of estimation of lighting conditions based on the camera image.
16+
17+
## Events reporting

plugins/camera/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Godot iOS Camera plugin
2+
3+
Uses Godot's `CameraServer` to handle iOS device camera feed.
4+
5+
## Methods
6+
7+
## Properties
8+
9+
## Events reporting

plugins/gamecenter/README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Godot iOS GameCenter plugin
2+
3+
## Methods
4+
5+
### Authorization
6+
7+
`authenticate()` - Performs user authentication.
8+
`is_authenticated()` - Returns authentication state.
9+
10+
### GameCenter methods
11+
12+
`post_score(Dictionary score_dictionary)` - Reports a score data to iOS `GameCenter`. Generates new event with `post_score` type.
13+
`award_achievement(Dictionary achievent_dictionary)` - Reports progress of achievement data to iOS `GameCenter`. Generates new event with `award_achievement` type.
14+
`reset_achievements()` - Resets all achievement progress for the local player. Generates new event with `reset_achievements` type.
15+
`request_achievements()` - Loads previously submitted achievement progress for the local player from iOS `GameCenter`. Generates new event with `achievements` type.
16+
`request_achievement_descriptions()` - Downloads the achievement descriptions from iOS `GameCenter`. Generates new event with `achievement_descriptions` type.
17+
`show_game_center(Dictionary screen_dictionary)` - Displays Game Center information of your game. Generates new event with `show_game_center` type when information screen closes.
18+
`request_identity_verification_signature()` - Creates a signature for a third-party server to authenticate the local player. Generates new event with `identity_verification_signature` type.
19+
20+
## Properties
21+
22+
## Events reporting
23+
24+
`get_pending_event_count()` - Returns number of events pending from plugin to be processed.
25+
`pop_pending_event()` - Returns first unprocessed plugin event.

plugins/icloud/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Godot iOS iCloud plugin
2+
3+
Plugin generates new event with `key_value_changed` type when values stored in the iCloud key-value store changes.
4+
5+
## Methods
6+
7+
`remove_key(String key)` - Removes the value associated with the specified key from the iCloud key-value store.
8+
`set_key_values(Dictionary values)` - Sets multiple objects for the specified keys in the iCloud key-value store.
9+
`get_key_value(String key)` - Returns the object associated with the specified key stored in iCloud key-value store.
10+
`synchronize_key_values()` - Synchronizes in-memory keys and values for iCloud storage with those stored on disk.
11+
`get_all_key_values()` - Returns a dictionary containing all of the key-value pairs in the iCloud key-value store.
12+
13+
## Properties
14+
15+
## Events reporting
16+
17+
`get_pending_event_count()` - Returns number of events pending from plugin to be processed.
18+
`pop_pending_event()` - Returns first unprocessed plugin event.

plugins/inappstore/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Godot iOS InAppStore plugin
2+
3+
## Methods
4+
5+
`request_product_info(Dictionary products_dictionary)` - Loads the unique identifiers for your in-app products in order to retrieve products information. Generates new event with `product_info` type.
6+
`restore_purchases()` - Asks App Store payment queue to restore previously completed purchases. Generates new event with `restore` type.
7+
`purchase(Dictionary product_dictionary)` - Adds a product payment request to the App Store payment queue. Generates new event with `purchase` type.
8+
`set_auto_finish_transaction(bool flag)` - Sets a value responsible for enabling automatic transaction finishing.
9+
`finish_transaction(String product_id)` - Notifies the App Store that the app finished processing the transaction.
10+
11+
## Properties
12+
13+
## Events reporting
14+
15+
`get_pending_event_count()` - Returns number of events pending from plugin to be processed.
16+
`pop_pending_event()` - Returns first unprocessed plugin event.

0 commit comments

Comments
 (0)