spacetraders/docs/ShipFrame.md

204 lines
5.4 KiB
Markdown

# ShipFrame
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Symbol** | **string** | |
**Name** | **string** | |
**Description** | **string** | |
**Condition** | Pointer to **int32** | Condition is a range of 0 to 100 where 0 is completely worn out and 100 is brand new. | [optional]
**ModuleSlots** | **int32** | |
**MountingPoints** | **int32** | |
**FuelCapacity** | **int32** | |
**Requirements** | [**ShipRequirements**](ShipRequirements.md) | |
## Methods
### NewShipFrame
`func NewShipFrame(symbol string, name string, description string, moduleSlots int32, mountingPoints int32, fuelCapacity int32, requirements ShipRequirements, ) *ShipFrame`
NewShipFrame instantiates a new ShipFrame object
This constructor will assign default values to properties that have it defined,
and makes sure properties required by API are set, but the set of arguments
will change when the set of required properties is changed
### NewShipFrameWithDefaults
`func NewShipFrameWithDefaults() *ShipFrame`
NewShipFrameWithDefaults instantiates a new ShipFrame object
This constructor will only assign default values to properties that have it defined,
but it doesn't guarantee that properties required by API are set
### GetSymbol
`func (o *ShipFrame) GetSymbol() string`
GetSymbol returns the Symbol field if non-nil, zero value otherwise.
### GetSymbolOk
`func (o *ShipFrame) GetSymbolOk() (*string, bool)`
GetSymbolOk returns a tuple with the Symbol field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetSymbol
`func (o *ShipFrame) SetSymbol(v string)`
SetSymbol sets Symbol field to given value.
### GetName
`func (o *ShipFrame) GetName() string`
GetName returns the Name field if non-nil, zero value otherwise.
### GetNameOk
`func (o *ShipFrame) GetNameOk() (*string, bool)`
GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetName
`func (o *ShipFrame) SetName(v string)`
SetName sets Name field to given value.
### GetDescription
`func (o *ShipFrame) GetDescription() string`
GetDescription returns the Description field if non-nil, zero value otherwise.
### GetDescriptionOk
`func (o *ShipFrame) GetDescriptionOk() (*string, bool)`
GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetDescription
`func (o *ShipFrame) SetDescription(v string)`
SetDescription sets Description field to given value.
### GetCondition
`func (o *ShipFrame) GetCondition() int32`
GetCondition returns the Condition field if non-nil, zero value otherwise.
### GetConditionOk
`func (o *ShipFrame) GetConditionOk() (*int32, bool)`
GetConditionOk returns a tuple with the Condition field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetCondition
`func (o *ShipFrame) SetCondition(v int32)`
SetCondition sets Condition field to given value.
### HasCondition
`func (o *ShipFrame) HasCondition() bool`
HasCondition returns a boolean if a field has been set.
### GetModuleSlots
`func (o *ShipFrame) GetModuleSlots() int32`
GetModuleSlots returns the ModuleSlots field if non-nil, zero value otherwise.
### GetModuleSlotsOk
`func (o *ShipFrame) GetModuleSlotsOk() (*int32, bool)`
GetModuleSlotsOk returns a tuple with the ModuleSlots field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetModuleSlots
`func (o *ShipFrame) SetModuleSlots(v int32)`
SetModuleSlots sets ModuleSlots field to given value.
### GetMountingPoints
`func (o *ShipFrame) GetMountingPoints() int32`
GetMountingPoints returns the MountingPoints field if non-nil, zero value otherwise.
### GetMountingPointsOk
`func (o *ShipFrame) GetMountingPointsOk() (*int32, bool)`
GetMountingPointsOk returns a tuple with the MountingPoints field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetMountingPoints
`func (o *ShipFrame) SetMountingPoints(v int32)`
SetMountingPoints sets MountingPoints field to given value.
### GetFuelCapacity
`func (o *ShipFrame) GetFuelCapacity() int32`
GetFuelCapacity returns the FuelCapacity field if non-nil, zero value otherwise.
### GetFuelCapacityOk
`func (o *ShipFrame) GetFuelCapacityOk() (*int32, bool)`
GetFuelCapacityOk returns a tuple with the FuelCapacity field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetFuelCapacity
`func (o *ShipFrame) SetFuelCapacity(v int32)`
SetFuelCapacity sets FuelCapacity field to given value.
### GetRequirements
`func (o *ShipFrame) GetRequirements() ShipRequirements`
GetRequirements returns the Requirements field if non-nil, zero value otherwise.
### GetRequirementsOk
`func (o *ShipFrame) GetRequirementsOk() (*ShipRequirements, bool)`
GetRequirementsOk returns a tuple with the Requirements field if it's non-nil, zero value otherwise
and a boolean to check if the value has been set.
### SetRequirements
`func (o *ShipFrame) SetRequirements(v ShipRequirements)`
SetRequirements sets Requirements field to given value.
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)