Menu
Lumberyard
Developer Guide (Version 1.11)

Static Data (PROTOTYPE) Nodes

Static Data is a Lumberyard system for managing game data that changes less frequently through monitored Amazon S3 buckets. You can use these flow graph nodes to update or query your buckets and/or monitor them at regular intervals for changes.

Add Monitored Bucket node

Adds an Amazon S3 bucket to monitor.


                    Add Monitored Bucket

Inputs

Port Type Description
AddBucket Void Adds a bucket to watch for updates
BucketName String The name of the Amazon S3 bucket to watch

Outputs

Port Type Description
Success Any Activated upon a successful operation
Error String Activated upon an error being detected; the value of the port is the error message
Finished String The bucket was added

Get Static Data node

Retrieves a field from a static data definition.


                    Get Static Data

Inputs

Port Type Description
Get Void Retrieves a value from static data
StaticDataType String The type of the static data to retrieve
StaticDataId String The identifier for the static data definition in the table
StaticDataField String The field name of the data to retrieve
ActivateOnUpdate Void Fire the node again the next time an update of the data takes place

Outputs

Port Type Description
Success Any Activated upon a successful operation
Error String Activated upon an error being detected; the value of the port is the error message
StringOut String The output of a string field
NumberOut Integer The output of a numeric field
BoolOut Boolean The output of a Boolean
FloatOut Integer The output of a floating point numeric field

Load Static Data node

Attempts to load static data of the type specified.


                    Load Static Data

Inputs

Port Type Description
Load Any Load a type of static data
StaticDataType String The type of static data to load

Outputs

Port Type Description
Success Any Activated upon a successful operation
Error String Activated upon an error being detected; the value of the port is the error message
Finished String Finished attempting to load

Remove Monitored Bucket node

Removes a bucket name from the list of monitored buckets.


                    Remove Monitored Bucket

Inputs

Port Type Description
Remove Any Removes a bucket from the list of monitored buckets
BucketName String The name of the bucket to remove

Outputs

Port Type Description
Success Any Activated upon a successful operation
Error String Activated upon an error being detected; the value of the port is the error message
Finished String Finished removing the bucket

Request Bucket node

Requests an update of a specific bucket, or of all monitored buckets.


                    Request Bucket

Inputs

Port Type Description
RequestBucket Any Requests an update of a specific bucket or of all monitored buckets
BucketName String The name of the bucket for which to request an update. To request updates for all buckets, leave this value blank.

Outputs

Port Type Description
Success Any Activated upon a successful operation
Error String Activated upon an error being detected; the value of the port is the error message
Finished String Finished sending the request

Set Update Frequency node

Sets or clears a recurring timer to poll monitored buckets.


                    Set Update Frequency

Inputs

Port Type Description
SetTimer Void Sets a recurring timer to the value specified in TimerValue
TimerValue Integer The time interval at which to poll. Possible values are from 0 to 100. A value of 0 clears the timer; 0 is the default.

Outputs

Port Type Description
Success Any Activated upon a successful operation
Error String Activated upon an error being detected; the value of the port is the error message
Set String The timer has been set